Torque3D Documentation / _generateds / afxBillboardData

afxBillboardData

consoledoc.h

A datablock that specifies a Billboard effect.

More...

Public Attributes

Selects a common blend factor preset. When set to 'user', srcBlendFactor and dstBlendFactor can be used to set additional blend factor combinations.

LinearColorF

The color assigned to the quadrangle geometry. The way it combines with the given texture varies according to the setting of the textureFunction field.

Point2F

A value-pair that specifies the horizontal and vertical dimensions of the billboard in scene units.

Specifies destination blend factor when blendStyle is set to 'user'.

Specifies source blend factor when blendStyle is set to 'user'.

filename

An image to use as the billboard's texture.

Point2F

An array of four value-pairs that specify the UV texture coordinates for the four corners of the billboard's quadrangle.

Detailed Description

A datablock that specifies a Billboard effect.

A Billboard effect is a textured quadrangle which is always aligned to face towards the camera. It is much like a single static particle and is rendered in a similar fashion.

Public Attributes

afxBillboard_BlendStyle blendStyle 

Selects a common blend factor preset. When set to 'user', srcBlendFactor and dstBlendFactor can be used to set additional blend factor combinations.

Possible values: normal, additive, subtractive, premultalpha, or user.

LinearColorF color 

The color assigned to the quadrangle geometry. The way it combines with the given texture varies according to the setting of the textureFunction field.

Point2F dimensions 

A value-pair that specifies the horizontal and vertical dimensions of the billboard in scene units.

GFXBlend dstBlendFactor 

Specifies destination blend factor when blendStyle is set to 'user'.

Possible values: GFXBlendZero, GFXBlendOne, GFXBlendSrcColor, GFXBlendInvSrcColor, GFXBlendSrcAlpha, GFXBlendInvSrcAlpha, GFXBlendDestAlpha, or GFXBlendInvDestAlpha

GFXBlend srcBlendFactor 

Specifies source blend factor when blendStyle is set to 'user'.

Possible values: GFXBlendZero, GFXBlendOne, GFXBlendDestColor, GFXBlendInvDestColor, GFXBlendSrcAlpha, GFXBlendInvSrcAlpha, GFXBlendDestAlpha, GFXBlendInvDestAlpha, or GFXBlendSrcAlphaSat

filename texture 

An image to use as the billboard's texture.

Point2F textureCoords [4]

An array of four value-pairs that specify the UV texture coordinates for the four corners of the billboard's quadrangle.