FaceColorMaterial Class


FaceColorMaterial Class

FaceColorMaterial can be used to render 3D objects with specifying color for each of its face (triangle). The face colors are provided with the FaceColors array (each array element provides Color4 for the triangle with the same index). When color's alpha value is below 0.01, then the whole triangle is discarded and will not be rendered.

Inheritance Hierarchy

SystemObject
  Ab3d.DirectXDXResourceBase
    Ab3d.DirectXSharedDXResource
      Ab3d.DirectXSharedDXDeviceResource
        Ab3d.DirectXMaterial
          Ab3d.DirectX.MaterialsFaceColorMaterial

Namespace: Ab3d.DirectX.Materials
Assembly: Ab3d.DXEngine (in Ab3d.DXEngine.dll) Version: 7.1.9105.2048 (1.0.0.0)

Syntax

Copy

public class FaceColorMaterial : Material, 
	IFaceColorMaterial, IDiffuseMaterial, ITransparentMaterial, IEmissiveMaterial, ISpecularMaterial, 
	ITwoSidedMaterial

The FaceColorMaterial type exposes the following members.

Constructors

	Name	Description
	FaceColorMaterial	Constructor
	FaceColorMaterial(Color4)	Constructor

Top

Properties

	Name	Description
	Alpha	Gets or sets a float value that defines the alpha value for the material.
	AmbientColor	Gets or sets a Color3 that specifies an color that defines how much ambient color is reflected by this material.
	CreateDynamicBuffer	Gets or sets a Boolean that specifies if a dynamic buffer will be created from the FaceColors array. This can be used in case when the colors change very often.
	DiffuseColor	Gets or sets a Color3 that specifies the diffuse color of this material.
	EmissiveColor	Gets or sets a Color3 that that represents the emissive color - the color of the object regardless of the lights.
	FaceColors	Gets or sets the Color4 array that specifies the colors for each face (triangle) of the object.
	FaceColorsShaderResourceView	Gets the ShaderResourceView that is created from FaceColors array.
	HasOnlyEmissiveColor	Gets or sets a Boolean that specifies if this material has only emissive color. If false than other material properties are also defined.
	HasSpecularColor	Gets a boolean that specifies if this material is using specular effect.
	HasTransparency	Gets a boolean that specifies if this material is semi-transparent and needs to be alpha blended with the scene.
	IsPreMultipliedAlphaColor	When IsPreMultipliedAlphaColor is true (false by default) and Alpha is less then 1, then the color components of the DiffuseColor are already multiplied with alpha value to produce pre-multiplied colors. When false, then non-pre-multiplied color is converted in pre-multiplied color when this is required by the shader.
	IsTwoSided	Gets or sets a Boolean that specifies if the material should be rendered on both front and back side. Default value is false.
	SpecularColor	Gets the Color3 that specifies the color used to draw the specular highlight effect.
	SpecularPower	Gets a float that specifies the power of the specular effect. Zero values means that the specular effect is turned off.

Top

Methods

	Name	Description
	ToString	ToString (Overrides MaterialToString)
	Update	Update method updates the DirectX vertex buffer from the current values of FaceColors.

Top

Remarks

FaceColorMaterial can be used to render 3D objects with specifying color for each of its face (triangle).

The face colors are provided with the FaceColors array (each array element provides Color4 for the triangle with the same index). When color's alpha value is below 0.01, then the whole triangle is discarded and will not be rendered.

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

Reference

Ab3d.DirectX.Materials Namespace