Effect::SetEffectListIndex
Defined in:
Sets the effect list index.
C4Effects.h
Prototype
void SetEffectListIndex(uint32 index);
Parameters
index |
The effect list index. This may be one of the values listed below. |
Description
The SetEffectListIndex
function sets the index of the render list in which the effect is placed when it is visible. The index
parameter can be one of the following constants.
kEffectListFullLight |
Fully lit opaque effects. These are rendered with all types of lighting just like ordinary geometry before all other effects. |
kEffectListPartialLight |
Partially lit transparent effects. These are rendered after surface effects and before primary transparent effects. Only ambient or unified lighting is applied. |
kEffectListOpaque |
Opaque effects. These are rendered after the final lighting pass and before any transparent effects. |
kEffectListSurface |
Surface effects. These are rendered after all opaque effects and before all transparent effects. |
kEffectListTransparent |
Primary transparent effects. These are rendered after all opaque effects and are sorted back to front. |
kEffectListFrontmost |
Frontmost transparent effects. These are rendered after primary transparent effects. They are not sorted. |
kEffectListOcclusion |
Occlusion queries. These are invisible effects that are rendered after the ambient or unified lighting pass to perform and occlusion query. |
kEffectListDistortion |
Distortion effects. These are rendered into the distortion buffer, and the accumulated results are applied during post-processing. |
kEffectListComposite |
Composite effects. These are rendered into the composite buffer, which is later used as a source for ordinary lighting passes. |
kEffectListTransparent
list, but some effect subclasses change this value.
See Also