csImageVolumeMaker Class Reference
[Graphics]
Wrapper class to create a volume aka 3D texture from a number of 2D images as the volume slices.
More...
#include <csgfx/imagevolumemaker.h>
Inheritance diagram for csImageVolumeMaker:

Public Member Functions | |
csImageVolumeMaker (int format=-1, int width=-1, int height=-1) | |
Create a new map without slices set. | |
csImageVolumeMaker (iImage *source) | |
Create a new map and copy slices from source. | |
virtual const void * | GetImageData () |
Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format. | |
virtual int | GetWidth () const |
Query image width. | |
virtual int | GetHeight () const |
Query image height. | |
virtual int | GetDepth () const |
Query image depth (only sensible when the image type is csimg3D). | |
virtual void | SetName (const char *iName) |
Set the name of the image. | |
virtual const char * | GetName () const |
Get the name of the image. | |
virtual int | GetFormat () const |
Qyery image format (see CS_IMGFMT_XXX above). | |
virtual const csRGBpixel * | GetPalette () |
Get image palette (or 0 if no palette). | |
virtual const uint8 * | GetAlpha () |
Get alpha map for 8-bit paletted image. | |
virtual const char * | GetRawFormat () const |
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided). | |
virtual csRef< iDataBuffer > | GetRawData () const |
Get the raw data of the image (or 0 if raw data is not provided). | |
virtual csImageType | GetImageType () const |
Get the type of the contained image. |
Detailed Description
Wrapper class to create a volume aka 3D texture from a number of 2D images as the volume slices.
Definition at line 39 of file imagevolumemaker.h.
Constructor & Destructor Documentation
|
Create a new map without slices set. Format, width, height are, unless specified, taken from the first image added. |
|
Create a new map and copy slices from source.
|
Member Function Documentation
|
Get alpha map for 8-bit paletted image. RGBA images contains alpha within themself. If image has no alpha map, or the image is in RGBA format, this function will return 0. Reimplemented from csImageBase. |
|
Query image depth (only sensible when the image type is csimg3D).
Reimplemented from csImageBase. Definition at line 73 of file imagevolumemaker.h. |
|
Qyery image format (see CS_IMGFMT_XXX above).
Implements iImage. |
|
Query image height.
Implements iImage. Definition at line 72 of file imagevolumemaker.h. |
|
Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format. Note that for RGBA images the csRGBpixel structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images). Implements iImage. |
|
Get the type of the contained image.
Reimplemented from csImageBase. Definition at line 90 of file imagevolumemaker.h. References csImageType. |
|
Get the name of the image.
Reimplemented from csImageBase. Definition at line 82 of file imagevolumemaker.h. |
|
Get image palette (or 0 if no palette).
Reimplemented from csImageBase. |
|
Get the raw data of the image (or 0 if raw data is not provided).
Reimplemented from csImageBase. Definition at line 89 of file imagevolumemaker.h. |
|
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided).
Reimplemented from csImageBase. Definition at line 88 of file imagevolumemaker.h. |
|
Query image width.
Implements iImage. Definition at line 71 of file imagevolumemaker.h. |
|
Set the name of the image.
Reimplemented from csImageBase. |
The documentation for this class was generated from the following file:
- csgfx/imagevolumemaker.h
Generated for Crystal Space by doxygen 1.3.9.1