OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Public Attributes | Package Functions | Properties | List of all members
OmegaEngine.EngineState Class Reference

Represents the current graphics render state of the Engine.Device. More...

Public Member Functions

void SetVertexBuffer (VertexBuffer buffer)
 Sets a VertexBuffer with a fixed-function vertex format as the current active stream source. More...
 
void SetTexture (ITextureProvider texture)
 Sets the currently active texture for the first texture stage. More...
 

Public Attributes

const int Opaque = 0
 Value for AlphaBlend to use no alpha blending More...
 
const int Invisible = 255
 Value for AlphaBlend to make something completley transparent (i.e., invisible) More...
 
const int AlphaChannel = 256
 Value for AlphaBlend to use alpha channel for transparency (augmented with alpha testing) More...
 
const int BinaryAlphaChannel = -256
 Value for AlphaBlend to use alpha channel for binary alpha testing More...
 
const int AdditivBlending = 257
 Value for AlphaBlend to apply additive blending (use color map) More...
 

Package Functions

 EngineState (Device device)
 Creates an engine state object. More...
 
void Reset ()
 Call when render states got reset to their default values on the device. More...
 

Properties

FillMode FillMode [get, set]
 Controls how vertexes are filled (normal, wireframe, dotted) More...
 
Cull CullMode [get, set]
 The current culling mode used for rendering More...
 
ZBufferMode ZBufferMode [get, set]
 Controls how the ZBuffer works More...
 
bool FfpLighting [get, set]
 Controls whether fixed-function pipeline lighting is used at the moment instead of SurfaceShaders More...
 
bool Fog [get, set]
 Shall a linear fog effect be applied? More...
 
Color FogColor [get, set]
 The color of the fog More...
 
float FogStart [get, set]
 The distance at which the linear fog shall start More...
 
float FogEnd [get, set]
 The distance at which the linear fog shall have obscured everything More...
 
int AlphaBlend [get, set]
 The level of transparency from 0 (solid) to 255 (invisible), AlphaChannel, BinaryAlphaChannel or AdditivBlending More...
 
Matrix WorldTransform [get, set]
 The currently active world transformation matrix More...
 
Matrix ViewTransform [get, set]
 The currently active view transformation matrix More...
 
Matrix ProjectionTransform [get, set]
 The currently active projection transformation matrix More...
 
Plane UserClipPlane [get, set]
 The currently active user clip plane; default Plane for none More...
 

Detailed Description

Represents the current graphics render state of the Engine.Device.

Constructor & Destructor Documentation

OmegaEngine.EngineState.EngineState ( Device  device)
inlinepackage

Creates an engine state object.

Parameters
deviceThe Direct3D device to be manipulated internally.

Member Function Documentation

void OmegaEngine.EngineState.Reset ( )
inlinepackage

Call when render states got reset to their default values on the device.

void OmegaEngine.EngineState.SetTexture ( ITextureProvider  texture)
inline

Sets the currently active texture for the first texture stage.

Parameters
textureThe object providing the texture.

Corresponds to calling SlimDX.Direct3D9.Device.SetTexture with the texture stage parameter set to 0.

void OmegaEngine.EngineState.SetVertexBuffer ( VertexBuffer  buffer)
inline

Sets a VertexBuffer with a fixed-function vertex format as the current active stream source.

Parameters
bufferThe VertexBuffer with a fixed-function vertex format.

Member Data Documentation

const int OmegaEngine.EngineState.AdditivBlending = 257

Value for AlphaBlend to apply additive blending (use color map)

const int OmegaEngine.EngineState.AlphaChannel = 256

Value for AlphaBlend to use alpha channel for transparency (augmented with alpha testing)

const int OmegaEngine.EngineState.BinaryAlphaChannel = -256

Value for AlphaBlend to use alpha channel for binary alpha testing

const int OmegaEngine.EngineState.Invisible = 255

Value for AlphaBlend to make something completley transparent (i.e., invisible)

const int OmegaEngine.EngineState.Opaque = 0

Value for AlphaBlend to use no alpha blending

Property Documentation

int OmegaEngine.EngineState.AlphaBlend
getset

The level of transparency from 0 (solid) to 255 (invisible), AlphaChannel, BinaryAlphaChannel or AdditivBlending

Cull OmegaEngine.EngineState.CullMode
getset

The current culling mode used for rendering

bool OmegaEngine.EngineState.FfpLighting
getset

Controls whether fixed-function pipeline lighting is used at the moment instead of SurfaceShaders

FillMode OmegaEngine.EngineState.FillMode
getset

Controls how vertexes are filled (normal, wireframe, dotted)

bool OmegaEngine.EngineState.Fog
getset

Shall a linear fog effect be applied?

Color OmegaEngine.EngineState.FogColor
getset

The color of the fog

float OmegaEngine.EngineState.FogEnd
getset

The distance at which the linear fog shall have obscured everything

float OmegaEngine.EngineState.FogStart
getset

The distance at which the linear fog shall start

Matrix OmegaEngine.EngineState.ProjectionTransform
getset

The currently active projection transformation matrix

Plane OmegaEngine.EngineState.UserClipPlane
getset

The currently active user clip plane; default Plane for none

When rendering without SurfaceShaders the clip plane must be in world space. When rendering with SurfaceShaders it must be in camera space.

Matrix OmegaEngine.EngineState.ViewTransform
getset

The currently active view transformation matrix

Matrix OmegaEngine.EngineState.WorldTransform
getset

The currently active world transformation matrix

ZBufferMode OmegaEngine.EngineState.ZBufferMode
getset

Controls how the ZBuffer works


The documentation for this class was generated from the following file: