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>
Inherits scfImplementationExt0< csImageVolumeMaker, csImageBase >.
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 char * | GetName () const |
Get the name of the image. | |
virtual void | SetName (const char *iName) |
Set the name of the image. | |
Protected Member Functions | |
void | AppendPending () |
Convert all added images to the right format and update data. | |
Protected Attributes | |
uint8 * | alpha |
Image alpha. | |
void * | data |
Image data. | |
int | Depth |
Depth of the image. | |
int | Format |
Format of the image. | |
int | Height |
Height of the image. | |
bool | manualName |
Whether the name was manually overridden (in this case it is not updated when the contained images are changed). | |
csRGBpixel * | palette |
Image palette. | |
csRefArray< iImage > | pendingImages |
Array of images that were added, but not yet processed into the image data. | |
int | Width |
Width of the 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 40 of file imagevolumemaker.h.
Constructor & Destructor Documentation
csImageVolumeMaker::csImageVolumeMaker | ( | int | format = -1 , |
|
int | width = -1 , |
|||
int | height = -1 | |||
) |
Create a new map without slices set.
Format, width, height are, unless specified, taken from the first image added.
csImageVolumeMaker::csImageVolumeMaker | ( | iImage * | source | ) |
Create a new map and copy slices from source.
Member Function Documentation
void csImageVolumeMaker::AppendPending | ( | ) | [protected] |
Convert all added images to the right format and update data.
virtual const char* csImageVolumeMaker::GetName | ( | ) | const [inline, virtual] |
Get the name of the image.
- Remarks:
- Unless the name was manually overridden with SetName(), the default name will contain the names of the wrapped slices, separated by ':', in the form
slice1.png:slice2.png:...
.
Definition at line 99 of file imagevolumemaker.h.
virtual void csImageVolumeMaker::SetName | ( | const char * | iName | ) | [virtual] |
Set the name of the image.
Member Data Documentation
uint8* csImageVolumeMaker::alpha [protected] |
Image alpha.
Definition at line 68 of file imagevolumemaker.h.
void* csImageVolumeMaker::data [protected] |
Image data.
Definition at line 64 of file imagevolumemaker.h.
int csImageVolumeMaker::Depth [protected] |
Depth of the image.
Definition at line 59 of file imagevolumemaker.h.
int csImageVolumeMaker::Format [protected] |
Format of the image.
Definition at line 61 of file imagevolumemaker.h.
int csImageVolumeMaker::Height [protected] |
Height of the image.
Definition at line 57 of file imagevolumemaker.h.
bool csImageVolumeMaker::manualName [protected] |
Whether the name was manually overridden (in this case it is not updated when the contained images are changed).
Definition at line 48 of file imagevolumemaker.h.
csRGBpixel* csImageVolumeMaker::palette [protected] |
Image palette.
Definition at line 66 of file imagevolumemaker.h.
csRefArray<iImage> csImageVolumeMaker::pendingImages [protected] |
Array of images that were added, but not yet processed into the image data.
Definition at line 53 of file imagevolumemaker.h.
int csImageVolumeMaker::Width [protected] |
Width of the image.
Definition at line 55 of file imagevolumemaker.h.
The documentation for this class was generated from the following file:
- csgfx/imagevolumemaker.h
Generated for Crystal Space 1.4.1 by doxygen 1.7.1