Ogre::RenderSystemCapabilities Class Reference

singleton class for storing the capabilities of the graphics card. More...

#include <OgreRenderSystemCapabilities.h>

List of all members.

Public Member Functions
	RenderSystemCapabilities ()
	~RenderSystemCapabilities ()
void	setNumWorldMatricies (ushort num)
void	setNumTextureUnits (ushort num)
void	setStencilBufferBitDepth (ushort num)
void	setNumVertexBlendMatrices (ushort num)
void	setNumMultiRenderTargets (ushort num)
	The number of simultaneous render targets supported.
ushort	getNumWorldMatricies (void) const
ushort	getNumTextureUnits (void) const
	Returns the number of texture units the current output hardware supports.
ushort	getStencilBufferBitDepth (void) const
	Determines the bit depth of the hardware accelerated stencil buffer, if supported.
ushort	numVertexBlendMatrices (void) const
	Returns the number of matrices available to hardware vertex blending for this rendering system.
ushort	numMultiRenderTargets (void) const
	The number of simultaneous render targets supported.
void	setCapability (const Capabilities c)
	Adds a capability flag to mCapabilities.
bool	hasCapability (const Capabilities c) const
	Checks for a capability.
const String &	getMaxVertexProgramVersion (void) const
	Gets the best low-level vertex program version supported.
const String &	getMaxFragmentProgramVersion (void) const
	Gets the best fragment program that this card / rendersystem supports.
ushort	getVertexProgramConstantFloatCount (void) const
	The number of floating-point constants vertex programs support.
ushort	getVertexProgramConstantIntCount (void) const
	The number of integer constants vertex programs support.
ushort	getVertexProgramConstantBoolCount (void) const
	The number of boolean constants vertex programs support.
ushort	getFragmentProgramConstantFloatCount (void) const
	The number of floating-point constants fragment programs support.
ushort	getFragmentProgramConstantIntCount (void) const
	The number of integer constants fragment programs support.
ushort	getFragmentProgramConstantBoolCount (void) const
	The number of boolean constants fragment programs support.
void	setMaxVertexProgramVersion (const String &ver)
	sets the best low-level vertex program version supported
void	setMaxFragmentProgramVersion (const String &ver)
	sets the best fragment program that this card / rendersystem supports
void	setVertexProgramConstantFloatCount (ushort c)
	The number of floating-point constants vertex programs support.
void	setVertexProgramConstantIntCount (ushort c)
	The number of integer constants vertex programs support.
void	setVertexProgramConstantBoolCount (ushort c)
	The number of boolean constants vertex programs support.
void	setFragmentProgramConstantFloatCount (ushort c)
	The number of floating-point constants fragment programs support.
void	setFragmentProgramConstantIntCount (ushort c)
	The number of integer constants fragment programs support.
void	setFragmentProgramConstantBoolCount (ushort c)
	The number of boolean constants fragment programs support.
void	setMaxPointSize (Real s)
	Maximum point screen size in pixels.
Real	getMaxPointSize (void) const
	Maximum point screen size in pixels.
void	log (Log *pLog)
	Write the capabilities to the pass in Log.
Private Attributes
ushort	mNumWorldMatrices
	The number of world matricies available.
ushort	mNumTextureUnits
	The number of texture units available.
ushort	mStencilBufferBitDepth
	The stencil buffer bit depth.
ushort	mNumVertexBlendMatrices
	The number of matrices available for hardware blending.
int	mCapabilities
	Stores the capabilities flags.
String	mMaxVertexProgramVersion
	The best vertex program that this card / rendersystem supports.
String	mMaxFragmentProgramVersion
	The best fragment program that this card / rendersystem supports.
ushort	mVertexProgramConstantFloatCount
	The number of floating-point constants vertex programs support.
ushort	mVertexProgramConstantIntCount
	The number of integer constants vertex programs support.
ushort	mVertexProgramConstantBoolCount
	The number of boolean constants vertex programs support.
ushort	mFragmentProgramConstantFloatCount
	The number of floating-point constants fragment programs support.
ushort	mFragmentProgramConstantIntCount
	The number of integer constants fragment programs support.
ushort	mFragmentProgramConstantBoolCount
	The number of boolean constants fragment programs support.
ushort	mNumMultiRenderTargets
	The number of simultaneous render targets supported.
Real	mMaxPointSize
	The maximum point size.

---

Detailed Description

singleton class for storing the capabilities of the graphics card.

Remarks:

This class stores the capabilities of the graphics card. This information is set by the individual render systems.

Definition at line 90 of file OgreRenderSystemCapabilities.h.

---

Constructor & Destructor Documentation

Ogre::RenderSystemCapabilities::RenderSystemCapabilities (   )

Ogre::RenderSystemCapabilities::~RenderSystemCapabilities (   )

---

Member Function Documentation

ushort Ogre::RenderSystemCapabilities::getFragmentProgramConstantBoolCount (  void   )  const

The number of boolean constants fragment programs support. Definition at line 254 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getFragmentProgramConstantFloatCount (  void   )  const

The number of floating-point constants fragment programs support. Definition at line 244 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getFragmentProgramConstantIntCount (  void   )  const

The number of integer constants fragment programs support. Definition at line 249 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

const String& Ogre::RenderSystemCapabilities::getMaxFragmentProgramVersion (  void   )  const

Gets the best fragment program that this card / rendersystem supports. Definition at line 224 of file OgreRenderSystemCapabilities.h. References Ogre::String.

Real Ogre::RenderSystemCapabilities::getMaxPointSize (  void   )  const

Maximum point screen size in pixels. Definition at line 307 of file OgreRenderSystemCapabilities.h. References Ogre::Real.

const String& Ogre::RenderSystemCapabilities::getMaxVertexProgramVersion (  void   )  const

Gets the best low-level vertex program version supported. Definition at line 219 of file OgreRenderSystemCapabilities.h. References Ogre::String.

ushort Ogre::RenderSystemCapabilities::getNumTextureUnits (  void   )  const

Returns the number of texture units the current output hardware supports. For use in rendering, this determines how many texture units the are available for multitexturing (i.e. rendering multiple textures in a single pass). Where a Material has multiple texture layers, it will try to use multitexturing where available, and where it is not available, will perform multipass rendering to achieve the same effect. Definition at line 169 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getNumWorldMatricies (  void   )  const

Definition at line 154 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getStencilBufferBitDepth (  void   )  const

Determines the bit depth of the hardware accelerated stencil buffer, if supported. Remarks: If hardware stencilling is not supported, the software will provide an 8-bit software stencil. Definition at line 180 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getVertexProgramConstantBoolCount (  void   )  const

The number of boolean constants vertex programs support. Definition at line 239 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getVertexProgramConstantFloatCount (  void   )  const

The number of floating-point constants vertex programs support. Definition at line 229 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::getVertexProgramConstantIntCount (  void   )  const

The number of integer constants vertex programs support. Definition at line 234 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

bool Ogre::RenderSystemCapabilities::hasCapability (  const Capabilities  c  )  const

Checks for a capability. Definition at line 207 of file OgreRenderSystemCapabilities.h.

void Ogre::RenderSystemCapabilities::log (  Log *  pLog  )

Write the capabilities to the pass in Log.

ushort Ogre::RenderSystemCapabilities::numMultiRenderTargets (  void   )  const

The number of simultaneous render targets supported. Definition at line 193 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

ushort Ogre::RenderSystemCapabilities::numVertexBlendMatrices (  void   )  const

Returns the number of matrices available to hardware vertex blending for this rendering system. Definition at line 187 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setCapability (  const Capabilities  c  )

Adds a capability flag to mCapabilities. Definition at line 200 of file OgreRenderSystemCapabilities.h.

void Ogre::RenderSystemCapabilities::setFragmentProgramConstantBoolCount (  ushort  c  )

The number of boolean constants fragment programs support. Definition at line 297 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setFragmentProgramConstantFloatCount (  ushort  c  )

The number of floating-point constants fragment programs support. Definition at line 287 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setFragmentProgramConstantIntCount (  ushort  c  )

The number of integer constants fragment programs support. Definition at line 292 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setMaxFragmentProgramVersion (  const String &  ver  )

sets the best fragment program that this card / rendersystem supports Definition at line 267 of file OgreRenderSystemCapabilities.h. References Ogre::String.

void Ogre::RenderSystemCapabilities::setMaxPointSize (  Real  s  )

Maximum point screen size in pixels. Definition at line 302 of file OgreRenderSystemCapabilities.h. References Ogre::Real.

void Ogre::RenderSystemCapabilities::setMaxVertexProgramVersion (  const String &  ver  )

sets the best low-level vertex program version supported Definition at line 262 of file OgreRenderSystemCapabilities.h. References Ogre::String.

void Ogre::RenderSystemCapabilities::setNumMultiRenderTargets (  ushort  num  )

The number of simultaneous render targets supported. Definition at line 149 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setNumTextureUnits (  ushort  num  )

Definition at line 133 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setNumVertexBlendMatrices (  ushort  num  )

Definition at line 143 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setNumWorldMatricies (  ushort  num  )

Definition at line 128 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setStencilBufferBitDepth (  ushort  num  )

Definition at line 138 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setVertexProgramConstantBoolCount (  ushort  c  )

The number of boolean constants vertex programs support. Definition at line 282 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setVertexProgramConstantFloatCount (  ushort  c  )

The number of floating-point constants vertex programs support. Definition at line 272 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

void Ogre::RenderSystemCapabilities::setVertexProgramConstantIntCount (  ushort  c  )

The number of integer constants vertex programs support. Definition at line 277 of file OgreRenderSystemCapabilities.h. References Ogre::ushort.

---

Member Data Documentation

int Ogre::RenderSystemCapabilities::mCapabilities [private]

Stores the capabilities flags. Definition at line 102 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mFragmentProgramConstantBoolCount [private]

The number of boolean constants fragment programs support. Definition at line 118 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mFragmentProgramConstantFloatCount [private]

The number of floating-point constants fragment programs support. Definition at line 114 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mFragmentProgramConstantIntCount [private]

The number of integer constants fragment programs support. Definition at line 116 of file OgreRenderSystemCapabilities.h.

String Ogre::RenderSystemCapabilities::mMaxFragmentProgramVersion [private]

The best fragment program that this card / rendersystem supports. Definition at line 106 of file OgreRenderSystemCapabilities.h.

Real Ogre::RenderSystemCapabilities::mMaxPointSize [private]

The maximum point size. Definition at line 122 of file OgreRenderSystemCapabilities.h.

String Ogre::RenderSystemCapabilities::mMaxVertexProgramVersion [private]

The best vertex program that this card / rendersystem supports. Definition at line 104 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mNumMultiRenderTargets [private]

The number of simultaneous render targets supported. Definition at line 120 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mNumTextureUnits [private]

The number of texture units available. Definition at line 96 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mNumVertexBlendMatrices [private]

The number of matrices available for hardware blending. Definition at line 100 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mNumWorldMatrices [private]

The number of world matricies available. Definition at line 94 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mStencilBufferBitDepth [private]

The stencil buffer bit depth. Definition at line 98 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mVertexProgramConstantBoolCount [private]

The number of boolean constants vertex programs support. Definition at line 112 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mVertexProgramConstantFloatCount [private]

The number of floating-point constants vertex programs support. Definition at line 108 of file OgreRenderSystemCapabilities.h.

ushort Ogre::RenderSystemCapabilities::mVertexProgramConstantIntCount [private]

The number of integer constants vertex programs support. Definition at line 110 of file OgreRenderSystemCapabilities.h.

---

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

• OgreRenderSystemCapabilities.h

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:42:18 2006