 | |
Vertex | |
VertexColorMaterial can be used to render 3D objects with specifying color for each of its position.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.MaterialsMaterial
Ab4d.SharpEngine.MaterialsVertexColorMaterial
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.MaterialsMaterial
Ab4d.SharpEngine.MaterialsVertexColorMaterial
Namespace: Ab4d.SharpEngine.Materials
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.1.9316+94bbd23b55747f096f056a5602f7dd90558b3673
SyntaxC#
public class VertexColorMaterial : Material, ITransparentMaterial, IVertexColorMaterial, IAlphaPreMultipliedMaterial
The VertexColorMaterial type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | VertexColorMaterial(String) | Constructor |
| VertexColorMaterial(Color4, String) | Constructor |
| VertexColorMaterial(Color4, Boolean, String) | Constructor |
Properties| Name | Description | |
|---|---|---|
 | HasTransparency | Gets a boolean that specifies if any color in PositionColors has alpha value less than 1 (is semi-transparent) so the mesh needs to be alpha blended to be rendered correctly. |
| IsPreMultipliedAlphaColor | When IsPreMultipliedAlphaColor is true (false by default), then the PositionColors array contains pre-multiplied colors (color components multiplied with alpha value). Default value is false. |
| PositionColors | 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. By default, the colors are not alpha pre-multiplied. To use alpha pre-multiplied colors, set the IsPreMultipliedAlphaColor property to true. |
| VertexColorsBuffer | Gets a GpuBuffer for an array of Color4 values where each value represents a color of one position (vertex). |
Methods| Name | Description | |
|---|---|---|
 | CreateClone | (Overrides MaterialCreateClone) |
| Dispose |
Dispose
(Overrides MaterialDispose(Boolean)) |
| OnEffectChanged |
OnEffectChanged is called after the effect is changed - overridden methods can return false to prevent the change of effect.
(Overrides MaterialOnEffectChanged(Effect, Effect)) |
| OnInitializeSceneResources |
Initializes resources with the specified Scene and GpuDevice.
This method can be overriden and is called from InitializeSceneResources(Scene) method.
(Overrides MaterialOnInitializeSceneResources(Scene, VulkanDevice)) |
| UpdatePositionColors | UpdatePositionColors must be called when the values in the PositionColors array are changed. |
| UpdatePositionColorsTransparency | UpdatePositionColorsTransparency method check if any color in the PositionColors has Alpha value less than 1 and sets HasTransparency accordingly. |
RemarksVertexColorMaterial 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