 | |
Effect Methods | |
The Effect type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ApplyRenderingItemMaterial | ApplyRenderingItemMaterial method sets the EffectTechnique, MaterialDescriptorSets and StateSortValue properties on the specified renderingItem. |
| BeginUpdate | BeginUpdate method is called for each registered effect before the SceneNodes and their materials are updated. It can be used to read some data from the RenderingContext (for example CurrentSwapChainImageIndex). It is used with the EndUpdate method to prepare all the data for the next rendered frame. BeginUpdate method internally calls OnBeginUpdate(RenderingContext) method that needs to be implemented by the derived effect. |
 | CheckIsDefaultEffect | Check if this is a default effect (IsDefaultEffect is true) and in this case throws an exception that it is not allowed to override material properties in this effect instance. |
| Cleanup | Cleanup method checks all memory blocks. Memory block is freed when it is empty and freeEmptyMemoryBlocks is true or when it empty for at least EngineRuntimeOptions.FramesCountToReleaseEmptyMemoryBlock frames. |
| Dispose | (Overrides ComponentBaseDispose(Boolean)) |
| DisposeMaterial | DisposeMaterial disposes the resources that are used by the specified material. Note that this method can be called on another thread. This happen when it is called called from destructor (finalizer). |
| EndUpdate | EndUpdate method is called after SceneNodes and their materials are updated. This method can update the material's buffers in case any of the material was changed. EndUpdate method internally calls OnEndUpdate method that needs to be implemented by the derived effect. |
| GetDetailsText | GetDetailsText adds string that writes details about this Effect into the specified StringBuilder. |
| GetMemoryInfo | GetMemoryInfo method returns a string that provides information about the memory usage of this effect. |
| InitializeMaterial | Initializes the material with this effect. This method is called when the specified material is used for the first time. This usually assigns the buffer and an index in the buffer to the material. |
| OnBeginUpdate | OnBeginUpdate method needs to be implemented by the effect class. The method is called from the BeginUpdate(RenderingContext) method. It can be used to read some data from the RenderingContext (for example CurrentSwapChainImageIndex). It is used with the OnEndUpdate method to prepare all the data for the next rendered frame. |
| OnEndUpdate | OnEndUpdate method needs to be implemented by the effect class. The method is called from the EndUpdate method. This method can update the material's buffers in case any of the material was changed. |
| OnSwapChainImagesCountChanged | OnSwapChainImagesCountChanged is called when the SwapChainImagesCount is changed (increased). |
| ResetPipelines | ResetPipelines is called when RenderPass or some other property of Pipeline is changed so that existing pipelines need to be recreated. |
| ResetPipelines(EffectTechnique) | ResetPipelines delay disposes all pipelines set to the CurrentPipeline in the specified array of EffectTechniques |
| ResetPipelines(StandardEffectTechnique) | ResetPipelines delay disposes all pipelines set to the CurrentPipeline in the specified array of EffectTechniques |
| SetMaterialBlock | Sets MaterialBlockIndex and MaterialIndex on the specified material. |
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString) |
| UpdateMaterial | UpdateMaterial method is called when the material is changed and its data need to updated. |
See Also