KFbxLayerElementTexture Class Reference

#include <kfbxlayer.h>
Inheritance diagram for KFbxLayerElementTexture:
Inheritance graph
[legend]

List of all members.


Detailed Description

Layer element for mapping Textures to a geometry.

Definition at line 2172 of file kfbxlayer.h.


Public Types

enum   EBlendMode {
   eTRANSLUCENT,
   eADD,
   eMODULATE,
   eMODULATE2,
   eOVER,
   eMAXBLEND
}
  Lets you control how textures are combined when you apply multiple layers of texture to a surface. More...

Public Member Functions

  CREATE_DECLARE (LayerElementTexture)
  Allocation method.
void  SetBlendMode (EBlendMode pBlendMode)
  Sets the way Textures blend between layers.
void  SetAlpha (double pAlpha)
  Sets the transparency level between multiple texture levels.
EBlendMode  GetBlendMode ()
  Returns the way Textures blend between layers.
double  GetAlpha ()
  Returns the transparency level between multiple levels of textures.

Member Enumeration Documentation

enum EBlendMode

Lets you control how textures are combined when you apply multiple layers of texture to a surface.

  • eTRANSLUCENT The new texture layer is transparent (depending on the Alpha value).
  • eADD Add the color of the new texture to the previous texture.
  • eMODULATE Multiples the color value of the new texture by the color values of all previous layers of texture.
  • eMODULATE2 Multiples the color value of the new texture by two and then by the color values of all previous layers of texture.
  • eOVER Blends the new texture over top of the old texture, according to the new texture's alpha channel.
  • eMAXBLEND Marks the end of the blend mode enum.
Enumerator:
eTRANSLUCENT 
eADD 
eMODULATE 
eMODULATE2 
eOVER 
eMAXBLEND 

Definition at line 2190 of file kfbxlayer.h.


Member Function Documentation

CREATE_DECLARE ( LayerElementTexture   ) 

Allocation method.

Returns:
A pointer to the layer element or NULL if creation fails.

void SetBlendMode ( EBlendMode  pBlendMode  )  [inline]

Sets the way Textures blend between layers.

Parameters:
pBlendMode  A valid blend mode.

Definition at line 2203 of file kfbxlayer.h.

void SetAlpha ( double  pAlpha  )  [inline]

Sets the transparency level between multiple texture levels.

Parameters:
pAlpha  Set to a value between 0.0 and 1.0, where 0.0 is totally transparent and 1.0 is totally opaque.
Remarks:
Values smaller than 0.0 are clipped to 0.0, while values greater than 1.0 are clipped to 1.0.

Definition at line 2209 of file kfbxlayer.h.

EBlendMode GetBlendMode (  )  [inline]

Returns the way Textures blend between layers.

Returns:
The current Blend Mode.

Definition at line 2222 of file kfbxlayer.h.

double GetAlpha (  )  [inline]

Returns the transparency level between multiple levels of textures.

Returns:
An alpha value between 0.0 and 1.0, where 0.0 is totally transparent and 1.0 is totally opaque.

Definition at line 2227 of file kfbxlayer.h.

KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture
KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture KFbxLayerElementTexture