Torque 3D - Script Manual: GFXSamplerStateData Class Reference

TorqueScript

Main   Class List   Namespace List   Online

GFXSamplerStateData Class Reference
[GFX]

A sampler state used by GFXStateBlockData. More...

Inheritance diagram for GFXSamplerStateData:

List of all members.

Public Attributes

GFXTextureArgument resultArg
 The selection of the destination register for the result of this stage. The default is GFXTACurrent.
GFXTextureTransformFlags textureTransform
 Sets the texture transform state. The default is GFXTTFFDisable.
Address Mode

GFXTextureAddressMode addressModeU
 The texture address mode for the u coordinate. The default is GFXAddressWrap.
GFXTextureAddressMode addressModeV
 The texture address mode for the v coordinate. The default is GFXAddressWrap.
GFXTextureAddressMode addressModeW
 The texture address mode for the w coordinate. The default is GFXAddressWrap.
Alpha Op

GFXTextureArgument alphaArg1
 The first alpha argument for the texture stage. The default value is GFXTATexture.
GFXTextureArgument alphaArg2
 The second alpha argument for the texture stage. The default value is GFXTADiffuse.
GFXTextureArgument alphaArg3
 The third alpha channel selector operand for triadic operations (multiply, add, and linearly interpolate). The default value is GFXTACurrent.
GFXTextureOp alphaOp
 The texture alpha blending operation. The default value is GFXTOPModulate.
Color Op

GFXTextureArgument colorArg1
 The first color argument for the texture stage. The default value is GFXTACurrent.
GFXTextureArgument colorArg2
 The second color argument for the texture stage. The default value is GFXTATexture.
GFXTextureArgument colorArg3
 The third color argument for triadic operations (multiply, add, and linearly interpolate). The default value is GFXTACurrent.
GFXTextureOp textureColorOp
 The texture color blending operation. The default value is GFXTOPDisable which disables the sampler.
Filter State

GFXTextureFilterType magFilter
 The texture magnification filter. The default is GFXTextureFilterLinear.
int maxAnisotropy
 The maximum texture anisotropy. The default value is 1.
GFXTextureFilterType minFilter
 The texture minification filter. The default is GFXTextureFilterLinear.
GFXTextureFilterType mipFilter
 The texture mipmap filter used during minification. The default is GFXTextureFilterLinear.
float mipLODBias
 The mipmap level of detail bias. The default value is zero.

Detailed Description

A sampler state used by GFXStateBlockData.

The samplers define how a texture will be sampled when used from the shader or fixed function device

Example:
singleton GFXSamplerStateData(SamplerClampLinear)
{
   textureColorOp = GFXTOPModulate;
   addressModeU = GFXAddressClamp;
   addressModeV = GFXAddressClamp;
   addressModeW = GFXAddressClamp;
   magFilter = GFXTextureFilterLinear;
   minFilter = GFXTextureFilterLinear;
   mipFilter = GFXTextureFilterLinear;
};

There are a few predefined samplers in the core scripts which you can use with GFXStateBlockData for the most common rendering cases:

  • SamplerClampLinear
  • SamplerClampPoint
  • SamplerWrapLinear
  • SamplerWrapPoint
See also:
GFXStateBlockData

Member Data Documentation

The texture address mode for the u coordinate. The default is GFXAddressWrap.

The texture address mode for the v coordinate. The default is GFXAddressWrap.

The texture address mode for the w coordinate. The default is GFXAddressWrap.

The first alpha argument for the texture stage. The default value is GFXTATexture.

The second alpha argument for the texture stage. The default value is GFXTADiffuse.

The third alpha channel selector operand for triadic operations (multiply, add, and linearly interpolate). The default value is GFXTACurrent.

The texture alpha blending operation. The default value is GFXTOPModulate.

The first color argument for the texture stage. The default value is GFXTACurrent.

The second color argument for the texture stage. The default value is GFXTATexture.

The third color argument for triadic operations (multiply, add, and linearly interpolate). The default value is GFXTACurrent.

The texture magnification filter. The default is GFXTextureFilterLinear.

The maximum texture anisotropy. The default value is 1.

The texture minification filter. The default is GFXTextureFilterLinear.

The texture mipmap filter used during minification. The default is GFXTextureFilterLinear.

The mipmap level of detail bias. The default value is zero.

The selection of the destination register for the result of this stage. The default is GFXTACurrent.

The texture color blending operation. The default value is GFXTOPDisable which disables the sampler.

Sets the texture transform state. The default is GFXTTFFDisable.



Copyright © GarageGames, LLC. All Rights Reserved.