#include <FCDEffectParameterSurface.h>
Inheritance diagram for FCDEffectParameterSurface:
Public Member Functions | |
FCDEffectParameterSurface (FCDocument *document) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectParameterSurface () |
Destructor: do not use directly. | |
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. | |
size_t | GetImageCount () const |
Retrieves the number of COLLADA images that make up this surface. | |
FCDImageList & | GetImages () |
Retrieves the list of images that make up this surface. | |
const FCDImageList & | GetImages () const |
See above. | |
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) |
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. | |
const char * | GetName (size_t index=0) const |
Retrieves a specific sub-id. | |
virtual FCDEffectParameter * | Clone () |
Creates a full copy of the effect parameter. | |
virtual void | Overwrite (FCDEffectParameter *target) |
[INTERNAL] Overwrites the target parameter with this parameter. | |
virtual FUStatus | LoadFromXML (xmlNode *parameterNode) |
[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. | |
virtual xmlNode * | WriteToXML (xmlNode *parentNode) const |
[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. |
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 FCDEffectParameterList::AddParameter function.
|
|
Destructor: do not use directly. Instead, use the FCDEffectParameterList::ReleaseParameter function. When released, the effect parameter list will also release all its parameters, if it owns them. |
|
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.
Implements FCDEffectParameter. |
|
Retrieves the index that matches the given image.
|
|
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. 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 a specific sub-id.
|
|
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.
|
|
[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
Reimplemented from 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.
|
|
[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
Reimplemented from FCDEffectParameter. |