#include <FCDEffectParameterSurface.h>
Inheritance diagram for FCDEffectParameterSurface:
Public Member Functions | |
FCDEffectParameterSurface (FCDocument *document) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectParameterSurface () |
Destructor. | |
virtual Type | GetType () const |
Retrieves the type of effect parameter class. | |
FCDEffectParameterSurfaceInit * | GetInitMethod () |
Retrieves the initialization method for the surface parameter. | |
const FCDEffectParameterSurfaceInit * | GetInitMethod () const |
See above. | |
void | SetInitMethod (FCDEffectParameterSurfaceInit *method) |
Sets the initialization method for the surface parameter. | |
const FCDImage ** | GetImages () const |
Retrieves the list of images that make up this surface. See above. | |
size_t | GetImageCount () const |
Retrieves the number of COLLADA images that make up this surface. | |
FCDImage * | GetImage (size_t index=0) |
Retrieves a specific image. | |
const FCDImage * | GetImage (size_t index=0) const |
See above. | |
size_t | FindImage (const FCDImage *image) const |
Retrieves the index that matches the given image. | |
size_t | AddImage (FCDImage *image, size_t index=(size_t)-1) |
Adds an image to the list. | |
void | RemoveImage (FCDImage *image) |
Removes an image from the list. | |
const FMVector3 & | GetSize () const |
Retrieves the wanted dimensions of the surface. | |
void | SetSize (const FMVector3 &dimensions) |
Sets the wanted dimensions of the surface. | |
float | GetViewportRatio () const |
Retrieves the viewport ratio to use when the surface is a render target. | |
void | SetViewportRatio (float ratio) |
Sets the viewport ratio to use when the surface is a render target. | |
uint16 | GetMipLevelCount () const |
Retrieves the wanted number of mip-levels. | |
void | SetMipLevelCount (uint16 levelCount) |
Sets the wanted number of mip-levels. | |
bool | IsGenerateMipMaps () const |
Retrieves whether to generate the mip-map levels on load. | |
void | SetGenerateMipMaps (bool _generateMipmaps) |
Sets whether to generate the mip-map levels of load. | |
void | SetFormat (const fm::string &_format) |
Sets/Gets format. | |
const fm::string & | GetFormat () |
void | SetSurfaceType (const fm::string &_type) |
Sets type. | |
const fm::string & | GetSurfaceType () |
Retrieves type. | |
virtual bool | IsValueEqual (FCDEffectParameter *parameter) |
Compares this parameter's value with another. | |
virtual FCDEffectParameter * | Clone (FCDEffectParameter *clone=NULL) const |
Creates a full copy of the effect parameter. | |
virtual void | Overwrite (FCDEffectParameter *target) |
[INTERNAL] Overwrites the target parameter with this parameter. | |
StringList & | GetNames () |
[INTERNAL] Retrieve the list of image names | |
FCDFormatHint * | AddFormatHint () |
Adds a format hint to the surface parameter. | |
FCDFormatHint * | GetFormatHint () |
Retrieves the format hint of the surface parameter. | |
const FCDFormatHint * | GetFormatHint () const |
This parameters hold the texture loading information. The texture placement information should be held by the sampler parameter.
|
Constructor: do not use directly. Instead, use the appropriate AddEffectParameter function.
|
|
Adds a format hint to the surface parameter. Will fail silently if one already exists. |
|
Adds an image to the list. The initialization method indexes the images from this list. This function will verify that this image does not already exist within the list, so use the returned index.
|
|
Creates a full copy of the effect parameter.
Reimplemented from FCDEffectParameter. |
|
Retrieves the index that matches the given image.
|
|
Retrieves the format hint of the surface parameter.
|
|
Retrieves a specific image.
|
|
Retrieves the number of COLLADA images that make up this surface. There should never be more than six images to build a surface. In the large majority of cases, expect one image.
|
|
Retrieves the list of images that make up this surface. See above. There should never be more than six images to build a surface. In the large majority of cases, expect one image.
|
|
Retrieves the initialization method for the surface parameter. The initialization method is a powerful method of describing how to build complex textures, such as cube maps, from one or multiple image files.
|
|
Retrieves the wanted number of mip-levels. This parameter is optional and may be zero to indicate that you should retrieve the mip-levels from the image file(s) or generate a full mip-chain, depending on the mip-map generate flag.
|
|
Retrieves the wanted dimensions of the surface. This parameter is optional and may contain all zeroes to indicate that you should read the surface dimensions from the image file(s).
|
|
Retrieves the type of effect parameter class.
Implements FCDEffectParameter. |
|
Retrieves the viewport ratio to use when the surface is a render target.
|
|
Retrieves whether to generate the mip-map levels on load. The alternative is to load the mip-map levels from the image files.
|
|
Compares this parameter's value with another.
Implements FCDEffectParameter. |
|
[INTERNAL] Overwrites the target parameter with this parameter. This function is used during the flattening of materials.
Reimplemented from FCDEffectParameter. |
|
Removes an image from the list. The initialization method indexes the images from this list. This function will shift all the indexes in the initialization method so that they continue matching the correct image.
|
|
Sets whether to generate the mip-map levels of load. The alternative is to load the mip-map levels from the image files.
|
|
Sets the initialization method for the surface parameter. The initialization method is a powerful method of describing how to build complex textures, such as cube maps, from one or multiple image files.
|
|
Sets the wanted number of mip-levels. This parameter is optional and can be zero to indicate that you should retrieve the mip-levels from the image file(s) or generate a full mip-chain, depending on the mip-map generate flag.
|
|
Sets the wanted dimensions of the surface. This parameter is optional and can contain all zeroes to indicate that you should read the surface dimensions from the image file(s).
|
|
Sets the viewport ratio to use when the surface is a render target.
|