CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

3D
[Graphics]


Classes

struct  csCoreRenderMesh
 Data required by the renderer to draw a mesh. More...
struct  csParticlesData
 Representational information of a particle. More...
struct  csPolygonRenderData
 This structure is used for communicating polygon information to the polygon renderer. More...
struct  csPolyTextureMapping
 This structure holds mapping information to map the texture and lightmap on a polygon. More...
class  csRenderBufferHolder
 Holder of standard renderbuffers. More...
struct  csRenderMesh
 Mesh data as returned by mesh plugins. More...
struct  csRenderMeshModes
 Mesh render mode information. More...
struct  iFireTexture
 Interface to the 'fire' procedural texture. More...
struct  iFireTexture
 Interface to the 'fire' procedural texture. More...
struct  iHalo
 iHalo: used to render halos (aka "light globes"). More...
struct  iHalo
 iHalo: used to render halos (aka "light globes"). More...
struct  iMaterial
 This class represents a material as seen from the engine view. More...
struct  iMaterial
 This class represents a material as seen from the engine view. More...
struct  iParticlesColorCallback
 Particles state can be set up to retrieve color via a callback. More...
struct  iParticlesColorCallback
 Particles state can be set up to retrieve color via a callback. More...
struct  iParticlesFactoryState
 Particles factory state. More...
struct  iParticlesFactoryState
 Particles factory state. More...
struct  iParticlesObjectState
 Particles state object. More...
struct  iParticlesObjectState
 Particles state object. More...
struct  iParticlesPhysics
 Particles physics interface. More...
struct  iParticlesPhysics
 Particles physics interface. More...
struct  iParticlesStateBase
 Particles shared state interface. More...
struct  iParticlesStateBase
 Particles shared state interface. More...
struct  iPolygonRenderer
struct  iPolygonRenderer
struct  iProcTexture
 Interface to a texture factory. More...
struct  iProcTexture
 Interface to a texture factory. More...
struct  iRenderBuffer
 This is a general buffer. More...
struct  iRenderBuffer
 This is a general buffer. More...
struct  iRenderBufferAccessor
 Interface for renderbuffer accessor. More...
struct  iTextureFactory
 Interface to a texture factory. More...
struct  iTextureFactory
 Interface to a texture factory. More...
struct  iTextureHandle
 A texture handle as returned by iTextureManager. More...
struct  iTextureHandle
 A texture handle as returned by iTextureManager. More...
struct  iTextureType
 Texture type. More...
struct  iTextureType
 Texture type. More...

Defines

#define CS_BUFFER_MAKE_MASKABLE(x)   (1<<(x))
#define CS_DEFMAT_AMBIENT   0.0f
 Default material `ambient' parameter.
#define CS_DEFMAT_DIFFUSE   0.7f
 Default material `diffuse' parameter.
#define CS_DEFMAT_REFLECTION   0.0f
 Default material `reflection' parameter.
#define CS_MATERIAL_TEXTURE_DIFFUSE   "tex diffuse"
 Name string for the material "diffuse" texture.
#define CS_MATERIAL_VARNAME_AMBIENT   "mat ambient"
 Name string for the material "ambient" shader var.
#define CS_MATERIAL_VARNAME_DIFFUSE   "mat diffuse"
 Name string for the material "diffuse" shader var.
#define CS_MATERIAL_VARNAME_FLATCOLOR   "mat flatcolor"
 Name string for the material "flat color" shader var.
#define CS_MATERIAL_VARNAME_REFLECTION   "mat reflection"
 Name string for the material "reflection" shader var.

Enumerations

enum  csParticleColorMethod
 Particle heat function. More...
enum  csParticleEmitType
 Particle emit type. More...
enum  csParticleFalloffType
 Particle force falloff type. More...
enum  csParticleForceType
 Particle force type. More...
enum  csRenderBufferComponentType
 Type of components. More...
enum  csRenderBufferLockType { , CS_BUF_LOCK_READ, CS_BUF_LOCK_NORMAL }
 Type of lock of a render buffer. More...
enum  csRenderBufferName { ,
  CS_BUFFER_INDEX, CS_BUFFER_POSITION, CS_BUFFER_NORMAL, CS_BUFFER_COLOR,
  CS_BUFFER_COLOR_UNLIT, CS_BUFFER_TEXCOORD0, CS_BUFFER_TEXCOORD1, CS_BUFFER_TEXCOORD2,
  CS_BUFFER_TEXCOORD3, CS_BUFFER_TEXCOORD_LIGHTMAP, CS_BUFFER_GENERIC0, CS_BUFFER_GENERIC1,
  CS_BUFFER_GENERIC2, CS_BUFFER_GENERIC3, CS_BUFFER_TANGENT, CS_BUFFER_BINORMAL,
  CS_BUFFER_COUNT
}
 Defines the names of the renderbuffers as provided by the meshes. More...
enum  csRenderBufferNameMask {
  CS_BUFFER_INDEX_MASK = 1 << CS_BUFFER_INDEX, CS_BUFFER_POSITION_MASK = 1 << CS_BUFFER_POSITION, CS_BUFFER_NORMAL_MASK = 1 << CS_BUFFER_NORMAL, CS_BUFFER_COLOR_MASK = 1 << CS_BUFFER_COLOR,
  CS_BUFFER_COLOR_LIGHTING_MASK = 1 << CS_BUFFER_COLOR_UNLIT, CS_BUFFER_TEXCOORD0_MASK = 1 << CS_BUFFER_TEXCOORD0, CS_BUFFER_TEXCOORD1_MASK = 1 << CS_BUFFER_TEXCOORD1, CS_BUFFER_TEXCOORD2_MASK = 1 << CS_BUFFER_TEXCOORD2,
  CS_BUFFER_TEXCOORD3_MASK = 1 << CS_BUFFER_TEXCOORD3, CS_BUFFER_TEXCOORD_LIGHTMAP_MASK = 1 << CS_BUFFER_TEXCOORD_LIGHTMAP, CS_BUFFER_GENERIC0_MASK = 1 << CS_BUFFER_GENERIC0, CS_BUFFER_GENERIC1_MASK = 1 << CS_BUFFER_GENERIC1,
  CS_BUFFER_GENERIC2_MASK = 1 << CS_BUFFER_GENERIC2, CS_BUFFER_GENERIC3_MASK = 1 << CS_BUFFER_GENERIC3, CS_BUFFER_TANGENT_MASK = 1 << CS_BUFFER_TANGENT, CS_BUFFER_BINORMAL_MASK = 1 << CS_BUFFER_BINORMAL,
  CS_BUFFER_ALL_MASK = ~0
}
 Masks for renderbuffer accessors. More...
enum  csRenderBufferType { CS_BUF_DYNAMIC, CS_BUF_STATIC, CS_BUF_STREAM }
 Buffer usage type. More...

Variables

static const size_t csRenderBufferComponentSizes [CS_BUFCOMP_TYPECOUNT]
 Sizes of individual buffer components in bytes.

Define Documentation

#define CS_DEFMAT_AMBIENT   0.0f
 

Default material `ambient' parameter.

Definition at line 38 of file material.h.

#define CS_DEFMAT_DIFFUSE   0.7f
 

Default material `diffuse' parameter.

Definition at line 36 of file material.h.

#define CS_DEFMAT_REFLECTION   0.0f
 

Default material `reflection' parameter.

Definition at line 40 of file material.h.

#define CS_MATERIAL_TEXTURE_DIFFUSE   "tex diffuse"
 

Name string for the material "diffuse" texture.

Definition at line 51 of file material.h.

#define CS_MATERIAL_VARNAME_AMBIENT   "mat ambient"
 

Name string for the material "ambient" shader var.

Definition at line 45 of file material.h.

#define CS_MATERIAL_VARNAME_DIFFUSE   "mat diffuse"
 

Name string for the material "diffuse" shader var.

Definition at line 43 of file material.h.

#define CS_MATERIAL_VARNAME_FLATCOLOR   "mat flatcolor"
 

Name string for the material "flat color" shader var.

Definition at line 49 of file material.h.

#define CS_MATERIAL_VARNAME_REFLECTION   "mat reflection"
 

Name string for the material "reflection" shader var.

Definition at line 47 of file material.h.


Enumeration Type Documentation

enum csParticleColorMethod
 

Particle heat function.

Definition at line 54 of file particles.h.

enum csParticleEmitType
 

Particle emit type.

Definition at line 64 of file particles.h.

enum csParticleFalloffType
 

Particle force falloff type.

Definition at line 46 of file particles.h.

enum csParticleForceType
 

Particle force type.

Definition at line 73 of file particles.h.

enum csRenderBufferComponentType
 

Type of components.

Definition at line 59 of file rndbuf.h.

enum csRenderBufferLockType
 

Type of lock of a render buffer.

Enumerator:
CS_BUF_LOCK_READ  Lock used for reading only from the buffer.
CS_BUF_LOCK_NORMAL  Just get a point to the buffer, nothing special.

Definition at line 76 of file rndbuf.h.

enum csRenderBufferName
 

Defines the names of the renderbuffers as provided by the meshes.

Remarks:
These constants are used to generate a mask (see csRenderBufferNameMask), hence their number should be kept below 32.
Enumerator:
CS_BUFFER_INDEX  Index buffer.
CS_BUFFER_POSITION  Vertex positions.
CS_BUFFER_NORMAL  Normals.
CS_BUFFER_COLOR  Primary color multiplied with lighting.
CS_BUFFER_COLOR_UNLIT  Primary color.
CS_BUFFER_TEXCOORD0  Texture coordinate 0.
CS_BUFFER_TEXCOORD1  Texture coordinate 1.
CS_BUFFER_TEXCOORD2  Texture coordinate 2.
CS_BUFFER_TEXCOORD3  Texture coordinate 3.
CS_BUFFER_TEXCOORD_LIGHTMAP  Texture coordinates for lightmap.
CS_BUFFER_GENERIC0  Generic buffer 0, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC1  Generic buffer 1, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC2  Generic buffer 2, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC3  Generic buffer 3, can be used for example for matrix-palette skinning etc.
CS_BUFFER_TANGENT  Tangents.
CS_BUFFER_BINORMAL  Binormals.
CS_BUFFER_COUNT  Not really a renderbuffer.

Use to determine the number of available default buffer names.

Definition at line 180 of file rndbuf.h.

enum csRenderBufferNameMask
 

Masks for renderbuffer accessors.

Enumerator:
CS_BUFFER_INDEX_MASK  Index buffer.
CS_BUFFER_POSITION_MASK  Vertex positions.
CS_BUFFER_NORMAL_MASK  Normals.
CS_BUFFER_COLOR_MASK  Primary color multiplied with lighting.
CS_BUFFER_COLOR_LIGHTING_MASK  Primary color.
CS_BUFFER_TEXCOORD0_MASK  Texture coordinate 0.
CS_BUFFER_TEXCOORD1_MASK  Texture coordinate 1.
CS_BUFFER_TEXCOORD2_MASK  Texture coordinate 2.
CS_BUFFER_TEXCOORD3_MASK  Texture coordinate 3.
CS_BUFFER_TEXCOORD_LIGHTMAP_MASK  Texture coordinates for lightmap.
CS_BUFFER_GENERIC0_MASK  Generic buffer 0, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC1_MASK  Generic buffer 1, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC2_MASK  Generic buffer 2, can be used for example for matrix-palette skinning etc.
CS_BUFFER_GENERIC3_MASK  Generic buffer 3, can be used for example for matrix-palette skinning etc.
CS_BUFFER_TANGENT_MASK  Tangents.
CS_BUFFER_BINORMAL_MASK  Binormals.
CS_BUFFER_ALL_MASK  All buffers.

Definition at line 226 of file rndbuf.h.

enum csRenderBufferType
 

Buffer usage type.

Drivers may do some optimizations based on this value. Use a type that most closely matches the intended use.

Enumerator:
CS_BUF_DYNAMIC  Data that changes every couple of frames and is drawn repeatedly.
CS_BUF_STATIC  Data that is seldom modified and often drawn.
CS_BUF_STREAM  Data that changes every time it is drawn.

Definition at line 48 of file rndbuf.h.


Variable Documentation

const size_t csRenderBufferComponentSizes[CS_BUFCOMP_TYPECOUNT] [static]
 

Initial value:

 
{
  sizeof (char), sizeof (unsigned char), 
  sizeof (short), sizeof (unsigned short),
  sizeof (int), sizeof (unsigned int),
  sizeof (float),
  sizeof (double)
}
Sizes of individual buffer components in bytes.

Definition at line 88 of file rndbuf.h.

Referenced by csRenderBuffer::GetElementDistance().


Generated for Crystal Space by doxygen 1.4.4