Click or drag to resize
Ab4d.SharpEngine logo

VertexColorMaterial Class

VertexColorMaterial can be used to render 3D objects with specifying color for each of its position.
Inheritance Hierarchy
SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.CoreInitializedSceneComponent
      Ab4d.SharpEngine.MaterialsMaterial
        Ab4d.SharpEngine.MaterialsVertexColorMaterial

Namespace: Ab4d.SharpEngine.Materials
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
public class VertexColorMaterial : Material, 
	ITransparentMaterial, IVertexColorMaterial

The VertexColorMaterial type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyHasTransparency Gets a boolean that specifies if this material is semi-transparent and needs to be alpha blended with the scene.
Public propertyPositionColors Gets or sets the Color4 array that specifies the colors for each position of the object. When the values in this array are changed after the material has already been initialized, then the UpdatePositionColors method must be called to update the VertexColorsBuffer.
Public propertyVertexColorsBuffer Gets a GpuBuffer for an array of Color4 values where each value represents a color of one position (vertex).
Top
Methods
 NameDescription
Protected methodCreateClone
(Overrides MaterialCreateClone)
Protected methodDispose Dispose
(Overrides MaterialDispose(Boolean))
Protected methodOnEffectChanged OnEffectChanged is called after the effect is changed - overridden methods can return false to prevent the change of effect.
(Overrides MaterialOnEffectChanged(Effect, Effect))
Protected methodOnInitializeSceneResources Initializes resources with the specified Scene and GpuDevice. This method can be override and is called from InitializeSceneResources(Scene) method.
(Overrides MaterialOnInitializeSceneResources(Scene, VulkanDevice))
Public methodUpdatePositionColors UpdatePositionColors must be called when the values in the PositionColors array are changed.
Public methodUpdatePositionColorsTransparency UpdatePositionColorsTransparency method check if any color in the PositionColors has Alpha value less than 1 and sets HasTransparency accordingly.
Top
Remarks

VertexColorMaterial can be used to render 3D objects with specifying color for each of its position.

The colors of each position is specified in the PositionColors array.

When values in the PositionColors array are changed, you need to call UpdatePositionColors method to update the DirectX resources.

See Also