#include <FCDEffectParameter.h>
Inheritance diagram for FCDEffectParameterSampler:
Public Types | |
enum | SamplerType { SAMPLER1D, SAMPLER2D, SAMPLER3D, SAMPLERCUBE } |
The type of sampling to execute. More... | |
Public Member Functions | |
FCDEffectParameterSampler (FCDocument *document) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectParameterSampler () |
Destructor: do not use directly. | |
virtual Type | GetType () const |
Retrieves the type of effect parameter class. | |
const char * | GetSurfaceSid () const |
Retrieves the sub-id of the surface parameter. | |
void | SetSurfaceSid (const char *sid) |
Sets the sub-id of the surface parameter to sample. | |
SamplerType | GetSamplerType () const |
Retrieves the type of sampling to do. | |
void | SetSamplerType (SamplerType type) |
Sets the type of sampling to do. | |
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. |
A sampler parameter provides the extra texturing information necessary to correctly sample a surface parameter. There are four types of samplers supported: 1D, 2D, 3D and cube.
|
The type of sampling to execute.
|
|
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. |
|
Creates a full copy of the effect parameter.
Implements FCDEffectParameter. |
|
Retrieves the type of sampling to do.
|
|
Retrieves the sub-id of the surface parameter. You will want to search for that sub-id within the parameters to find the FCDEffectParameterSurface object.
|
|
Retrieves the type of effect parameter class.
Implements FCDEffectParameter. |
|
[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. |
|
Sets the type of sampling to do.
|
|
Sets the sub-id of the surface parameter to sample.
|
|
[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
Reimplemented from FCDEffectParameter. |