Click or drag to resize
Ab4d.SharpEngine logo

SolidColorEffect Class

Inheritance Hierarchy
SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.CoreSceneComponent
      Ab4d.SharpEngine.EffectsEffect
        Ab4d.SharpEngine.EffectsCommonEffectStandardEffectTechnique
          Ab4d.SharpEngine.EffectsSolidColorEffect

Namespace: Ab4d.SharpEngine.Effects
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035
Syntax
C#
Copy
public class SolidColorEffect : CommonEffect<StandardEffectTechnique>, 
	IEffectConstructor<SolidColorEffect>

The SolidColorEffect type exposes the following members.

Properties
 NameDescription
Public propertyOverrideColor Gets or sets a Color4 that will be used as solid color and alpha value for all objects rendered by this effect. This property can be set only on custom effect instance (IsDefaultEffect is false) that is created by CreateNew method and cannot be changed on default implementation of the effect (get by GetDefault method).
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 empty for at least EngineRuntimeOptions.FramesCountToReleaseEmptyMemoryBlock frames.
(Overrides EffectCleanup(Boolean, Boolean))
Public methodStatic memberCreateNew 
Protected methodDispose
(Overrides EffectDispose(Boolean))
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 methodStatic memberGetDefault 
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 method. This method can update the material's buffers in case any of the material was changed.
(Overrides EffectOnEndUpdate)
Protected methodOnInitializeDeviceResources Initializes resources with the specified GpuDevice. This method can be overriden and is called from InitializeDeviceResources method.
(Overrides SceneComponentOnInitializeDeviceResources(VulkanDevice))
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 methodUpdateMaterial UpdateMaterial method is called when the material is changed and its data need to be updated.
(Overrides EffectUpdateMaterial(Material))
Top
See Also