#include <FCDEffectPass.h>
Inheritance diagram for FCDEffectPass:
Public Member Functions | |
FCDEffectPass (FCDocument *document, FCDEffectTechnique *parent) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectPass () |
Destructor. | |
FCDEffectTechnique * | GetParent () |
Retrieves the effect techniques which contains this effect pass. | |
const FCDEffectTechnique * | GetParent () const |
See above. | |
DEPRECATED (3.05A, GetParent()->GetParent()->GetParent()->GetDaeId()) const fm | |
Retrieves the COLLADA id of the parent effect. | |
const fstring & | GetPassName () const |
Retrieves the sub-id of the effect pass. | |
void | SetPassName (const fchar *_name) |
Sets the optional sub-id for the effect pass. | |
size_t | GetShaderCount () const |
Retrieves the number of shaders contained within the effect pass. | |
FCDEffectPassShader * | GetShader (size_t index) |
Retrieves a specific shader. | |
const FCDEffectPassShader * | GetShader (size_t index) const |
See above. | |
FCDEffectPassShader * | AddShader () |
Adds a new shader to the pass. | |
DEPRECATED (3.05A, shader->Release()) void ReleaseShader(FCDEffectPassShader *shader) | |
Releases a shader contained within the pass. | |
FCDEffectPassShader * | GetVertexShader () |
Retrieves the vertex shader for this effect pass. | |
const FCDEffectPassShader * | GetVertexShader () const |
See above. | |
FCDEffectPassShader * | GetFragmentShader () |
Retrieves the fragment shader for this effect pass. | |
const FCDEffectPassShader * | GetFragmentShader () const |
See above. | |
FCDEffectPassShader * | AddVertexShader () |
Adds a new vertex shader to the pass. | |
FCDEffectPassShader * | AddFragmentShader () |
Adds a new fragment shader to the pass. | |
DEPRECATED (3.05A, GetRenderStateCount and GetRenderState(index)) void GetRenderStates() const | |
Retrieves the container of the render states for the pass. | |
size_t | GetRenderStateCount () const |
Retrieves the number of render states defined for the pass. | |
FCDEffectPassState * | GetRenderState (size_t index) |
Retrieves a specific render state defined for the pass. | |
const FCDEffectPassState * | GetRenderState (size_t index) const |
See above. | |
FCDEffectPassState * | AddRenderState (FUDaePassState::State type) |
Adds a new render state to the effect pass. | |
FCDEffectPassState * | FindRenderState (FUDaePassState::State type) |
Retrieves a specific render state defined for the pass. | |
const FCDEffectPassState * | FindRenderState (FUDaePassState::State type) const |
See above. | |
FCDEffectPass * | Clone (FCDEffectPass *clone=NULL) const |
Clones the effect pass and shaders. |
The effect pass contains a list of effect shaders. While they may be missing, it does not make sense for the effect pass to contain more than two shaders: a vertex shader and a fragment/pixel shader.
For this reason, we provide the GetVertexShader and the GetFragmentShader which we expect will be used for most applications, rather than looking through the list of shader objects.
|
Constructor: do not use directly. Instead, use the FCDEffectTechnique::AddPass function.
|
|
Adds a new fragment shader to the pass. If a fragment shader already exists within the pass, it will be released.
|
|
Adds a new render state to the effect pass. Render states automatically get sorted by type.
|
|
Adds a new shader to the pass.
|
|
Adds a new vertex shader to the pass. If a vertex shader already exists within the pass, it will be released.
|
|
Clones the effect pass and shaders.
|
|
Retrieves the container of the render states for the pass.
|
|
Releases a shader contained within the pass.
|
|
Retrieves the COLLADA id of the parent effect. This function is mostly useful as a shortcut for debugging and reporting.
|
|
Retrieves a specific render state defined for the pass.
|
|
Retrieves the fragment shader for this effect pass.
|
|
Retrieves the effect techniques which contains this effect pass.
|
|
Retrieves the sub-id of the effect pass. This sub-id is optional.
|
|
Retrieves a specific render state defined for the pass.
|
|
Retrieves the number of render states defined for the pass.
|
|
Retrieves a specific shader.
|
|
Retrieves the number of shaders contained within the effect pass.
|
|
Retrieves the vertex shader for this effect pass.
|
|
Sets the optional sub-id for the effect pass. This sub-id is optional.
|