Click or drag to resize
Ab4d.SharpEngine logo

StandardEffect Class

Inheritance Hierarchy

Namespace: Ab4d.SharpEngine.Effects
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 4.1.9680+a1b1e43de1ad9a7e35472c33948d688d7b40ef79
Syntax
C#
Copy
public class StandardEffect : CommonEffect<StandardEffectTechnique>, 
	IEffectConstructor<StandardEffect>

The StandardEffect type exposes the following members.

Constructors
 NameDescription
Protected methodStandardEffect Constructor
Top
Methods
 NameDescription
Public methodApplyRenderingItemMaterial ApplyRenderingItemMaterial method sets the EffectTechnique, MaterialDescriptorSets and StateSortValue properties on the specified renderingItem.
(Overrides EffectApplyRenderingItemMaterial(RenderingItem, Material, RenderingContext))
Public methodCleanup Cleanup method checks all memory blocks. Memory block is freed when it is empty and freeEmptyMemoryBlocks is true or when it is empty for at least EngineRuntimeOptions.FramesCountToReleaseEmptyMemoryBlock frames.
(Overrides EffectCleanup(Boolean, Boolean))
Public methodStatic memberCreateNew 
Public methodCreateStandardDescriptorSets 
Protected methodDispose
(Overrides EffectDispose(Boolean))
Public methodDisposeDescriptorSetForTexture Disposes the descriptor set that was created by GetDescriptorSetForTexture method.
Public methodDisposeMaterial DisposeMaterial disposes the resources that are used by the specified material. Note that this method can be called on another thread. This happens when it is called from destructor (finalizer).
(Overrides EffectDisposeMaterial(Material))
Public methodFreeDescriptorSets 
Public methodStatic memberGetDefault 
Public methodGetMemoryInfo GetMemoryInfo method returns a string that provides information about the memory usage of this effect.
(Overrides EffectGetMemoryInfo(Boolean))
Public methodInitializeMaterial 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.
(Overrides EffectInitializeMaterial(Material))
Public methodOnEndUpdate OnEndUpdate method needs to be implemented by the effect class. The method is called from the EndUpdate(RenderingContext) method. This method can update the material's buffers in case any of the material was changed.
(Overrides EffectOnEndUpdate(RenderingContext))
Protected methodOnInFlightFramesCountChanged
(Overrides EffectOnInFlightFramesCountChanged(Int32))
Protected methodOnInitializeDeviceResources Initializes resources with the specified GpuDevice. This method can be overriden and is called from InitializeDeviceResources method.
(Overrides SceneComponentOnInitializeDeviceResources(VulkanDevice))
Public methodResetEffectTechniques ResetEffectTechniques recreates all the effect techniques. It is called when the DefaultTransparentDepthStencilState and other default settings are changed.
(Overrides CommonEffectTResetEffectTechniques)
Public methodResetPipelines ResetPipelines is called when RenderPass or some other property of Pipeline is changed so that existing pipelines need to be recreated.
(Overrides EffectResetPipelines)
Public methodSetMaterialInstanceData 
Public methodUpdateMaterial UpdateMaterial method is called when the material is changed and its data need to be updated.
(Overrides EffectUpdateMaterial(Material))
Top
Fields
See Also