n3dtypes.h File Reference

#include "n3dcolor.inl"
#include "n3dfloat.inl"
#include "n3dvector3.inl"

Data Structures
struct	N3DCMDSTREAM
	Describes a Command Stream. More...
struct	N3DCOLOR
	Describes color values. More...
struct	N3DFLOAT
	Describes a signed 32bit fixed point type. More...
struct	N3DLIGHT
	Describes light properties. More...
struct	N3DMATERIAL
	Describes material properties. More...
struct	N3DMATRIX
	Describes a 4x4 matrix. More...
struct	N3DVECTOR3
	Describes a vector in 3D space. More...
struct	N3DVIEWPORT
	Describes a 2D rectangle where the 3D scene is projected into. More...
Typedefs
typedef unsigned int	N3DBOOL
	Describes a 32bit boolean type.
Enumerations
enum	N3DCULL {   N3DCULL_CW = 1 << 6,   N3DCULL_CWW = 1 << 7,   N3DCULL_NONE = N3DCULL_CW | N3DCULL_CWW }
	Describes the supported culling modes. More...
enum	N3DFILL {   N3DFILL_WIRE,   N3DFILL_SOLID }
	Describes the supported polygon fill modes. More...
enum	N3DFORMAT {   N3DFMT_A3P5 = 1,   N3DFMT_P2 = 2,   N3DFMT_P4 = 3,   N3DFMT_P8 = 4,   N3DFMT_A5P3 = 6,   N3DFMT_A1B5G5R5 = 7 }
	Describes the supported formats. More...
enum	N3DPRIMITIVETYPE {   N3DPT_TRIANGLELIST,   N3DPT_QUADLIST,   N3DPT_TRIANGLESTRIP,   N3DPT_QUADSTRIP }
	Describes the supported primitive types. More...
enum	N3DRENDERSTATETYPE {   N3DRS_CULLMODE,   N3DRS_ANTIALIASEENABLE,   N3DRS_ALPHABLENDENABLE,   N3DRS_ALPHATESTENABLE,   N3DRS_ALPHAREF,   N3DRS_FARPLANEPOLYGONREJECT,   N3DRS_FILLMODE,   N3DRS_ZENABLE }
	Describes the supported render states. More...
enum	N3DTEXTUREADDRESS {   N3DTADDRESS_WRAP,   N3DTADDRESS_MIRROR,   N3DTADDRESS_CLAMP }
	Describes the supported texture address modes. More...
enum	N3DTEXTUREOP {   N3DTOP_DISABLE,   N3DTOP_MODULATE,   N3DTOP_BLENDTEXTUREALPHA }
	Describes the supported texture operations. More...
enum	N3DTEXTURESTATETYPE {   N3DTST_ADDRESSU,   N3DTST_ADDRESSV,   N3DTST_COLOROP,   N3DTST_TEXTURETRANSFORMFLAGS }
	Describes the supported texture state types. More...
enum	N3DTEXTURETRANSFORMFLAGS {   N3DTTFF_DISABLE = 1,   N3DTTFF_NORMAL = 2,   N3DTTFF_POSITION = 3 }
	Describes the supported texture transformations. More...
enum	N3DTRANSFORMSTATETYPE {   N3DTS_PROJECTION = 0,   N3DTS_WORLD = 2,   N3DTS_TEXTURE = 3,   N3DTS_VIEW = 4 }
	Describes the transformation state values. More...
enum	N3DZBUFFERTYPE {   N3DZB_TRUE = 0,   N3DZB_USEW = 1 }
	Describes the supported depth-buffer types. More...

---

Detailed Description

---

Enumeration Type Documentation

enum N3DCULL

Describes the supported culling modes.

Example:

N3DDEVICE device;

device.SetRenderState(N3DRS_CULLMODE, N3DCULL_CWW);

See also:

N3DRENDERSTATETYPE

Enumerator:

N3DCULL_CW	Cull back faces with clockwise vertices.
N3DCULL_CWW	Cull back faces with counterclockwise vertices.
N3DCULL_NONE	Don't cull back faces.

enum N3DFILL

Describes the supported polygon fill modes.

Example:

N3DDEVICE device;

device.SetRenderState(N3DRS_FILLMODE, N3DFILL_WIRE);

See also:

N3DRENDERSTATETYPE

Enumerator:

N3DFILL_WIRE	Fill wireframes. No alphablending is performed in wireframe-mode.
N3DFILL_SOLID	Fill solids.

enum N3DFORMAT

Describes the supported formats.

See also:

N3DDEVICE::SetTexture

Enumerator:

N3DFMT_A3P5	5 bit color indexed with 3 bits of alpha (32 colors, 8 alpha weights).
N3DFMT_P2	2 bit color indexed (4 colors).
N3DFMT_P4	4 bit color indexed (16 colors).
N3DFMT_P8	8 bit color indexed (256 colors).
N3DFMT_A5P3	3 bit color indexed with 5 bits of alpha (8 colors, 32 alpha weights).
N3DFMT_A1B5G5R5	16 bit pixel format, 5 bits for each color and 1 bit for alpha (32767 colors, translucent or opaque).

enum N3DPRIMITIVETYPE

Describes the supported primitive types.

See also:

N3DCMDSTREAM

Enumerator:

N3DPT_TRIANGLELIST	Separate triangle.
N3DPT_QUADLIST	Separate quad.
N3DPT_TRIANGLESTRIP	Triangle strip.
N3DPT_QUADSTRIP	Quad strip.

enum N3DRENDERSTATETYPE

Describes the supported render states.

See also:

N3DDEVICE::SetRenderState

Enumerator:

N3DRS_CULLMODE	Describes the culling-mode. See N3DCULL.
N3DRS_ANTIALIASEENABLE	TRUE to enable, FALSE to disable antialiasing. The default is FALSE. Don't think of antialiasing as texture filtering, it smooths the edges of polygons only, no interpolation between texels is performed.
N3DRS_ALPHABLENDENABLE	TRUE to enable, FALSE to disable. The default is FALSE.
N3DRS_ALPHATESTENABLE	TRUE to enable, false to disable. The default is FALSE.
N3DRS_ALPHAREF	Alpha comparison value from N3DFLOAT(0) through N3DFLOAT(1.0).
N3DRS_FARPLANEPOLYGONREJECT	TRUE to reject polygons that have an intersection with the far plane, or FALSE to clip and render them. The default is FALSE.
N3DRS_FILLMODE	Describes the fill-mode. See N3DFILL. The default is N3DFILL_SOLID.
N3DRS_ZENABLE	Describes the depth-buffering type. See N3DZBUFFERTYPE. The default is N3DZB_TRUE.

enum N3DTEXTUREADDRESS

Describes the supported texture address modes.

See also:

N3DTEXTURESTATETYPE, N3DTST_ADDRESSU, N3DTST_ADDRESSV

Todo:

Add documentation and sample pictures.

Enumerator:

N3DTADDRESS_WRAP	Wrap.
N3DTADDRESS_MIRROR	Mirror.
N3DTADDRESS_CLAMP	Clamp.

enum N3DTEXTUREOP

Describes the supported texture operations.

Remarks:

tc = texture color
vc = vertex color

See also:

N3DDEVICE::SetTextureState, N3DTST_COLOROP

Enumerator:

N3DTOP_DISABLE	No texture mapping is performed.
N3DTOP_MODULATE	tc * vc
N3DTOP_BLENDTEXTUREALPHA	(tc * alpha) + vc * (1 - alpha)

enum N3DTEXTURESTATETYPE

Describes the supported texture state types.

Example:

N3DDEVICE device;

device.SetTextureState(N3DTST_ADDRESSU, N3DTADDRESS_MIRROR);
device.SetTextureState(N3DTST_ADDRESSV, N3DTADDRESS_MIRROR);
device.SetTextureState(N3DTST_COLOROP, N3DTOP_MODULATE);

See also:

N3DDEVICE::SetTextureState

Enumerator:

N3DTST_ADDRESSU	Texture-address mode for the u coordinate. The default is N3DTADDRESS_WRAP.
N3DTST_ADDRESSV	Texture-address mode for the v coordinate. The default is N3DTADDRESS_WRAP.
N3DTST_COLOROP	Texture-operation mode. The default is N3DTOP_MODULATE.
N3DTST_TEXTURETRANSFORMFLAGS	Texture-transformation mode. The default is N3DTTFF_DISABLE.

enum N3DTEXTURETRANSFORMFLAGS

Describes the supported texture transformations.

See also:

N3DDEVICE::SetTextureState, N3DTST_TEXTURETRANSFORMFLAGS

Enumerator:

N3DTTFF_DISABLE	No transformation applied to texture coordinates.
N3DTTFF_NORMAL	Texture coordinates are multiplied by current vertex normal.
N3DTTFF_POSITION	Texture coordinates are multiplied by current vertex position.

enum N3DTRANSFORMSTATETYPE

Describes the transformation state values.

See also:

N3DDEVICE:SetTransform

Enumerator:

N3DTS_PROJECTION	Identifies the projection matrix.
N3DTS_WORLD	Identifies the world matrix.
N3DTS_TEXTURE	Identifies the texture matrix.
N3DTS_VIEW	Identifies the view matrix.

enum N3DZBUFFERTYPE

Describes the supported depth-buffer types.

Example:

N3DDEVICE device;

device.SetRenderState(N3DRS_ZENABLE, N3DZB_USEW);

Remarks:

Depth-buffering cannot be disabled.

See also:

N3DRENDERSTATETYPE

Enumerator:

N3DZB_TRUE	Use z-buffering.
N3DZB_USEW	Use w-buffering.

---