RageDisplay Class Reference

#include <RageDisplay.h>

Inheritance diagram for RageDisplay:

[legend]Collaboration diagram for RageDisplay:

[legend]List of all members.

Public Types
enum	PixelFormat {   FMT_RGBA8, FMT_RGBA4, FMT_RGB5A1, FMT_RGB5,   FMT_RGB8, FMT_PAL, FMT_BGR8, FMT_A1BGR5,   NUM_PIX_FORMATS }
enum	GraphicsFileFormat { SAVE_LOSSLESS, SAVE_LOSSY_LOW_QUAL, SAVE_LOSSY_HIGH_QUAL }
Public Member Functions
virtual const PixelFormatDesc *	GetPixelFormatDesc (PixelFormat pf) const =0
virtual	~RageDisplay ()
virtual void	Update (float fDeltaTime)
CString	SetVideoMode (VideoModeParams p, bool &bNeedReloadTextures)
virtual void	ResolutionChanged ()
virtual bool	BeginFrame ()=0
virtual void	EndFrame ()=0
virtual VideoModeParams	GetVideoModeParams () const =0
bool	IsWindowed () const
virtual void	SetBlendMode (BlendMode mode)=0
virtual bool	SupportsTextureFormat (PixelFormat pixfmt, bool realtime=false)=0
virtual unsigned	CreateTexture (PixelFormat pixfmt, RageSurface *img, bool bGenerateMipMaps)=0
virtual void	UpdateTexture (unsigned uTexHandle, RageSurface *img, int xoffset, int yoffset, int width, int height)=0
virtual void	DeleteTexture (unsigned uTexHandle)=0
virtual void	ClearAllTextures ()=0
virtual int	GetNumTextureUnits ()=0
virtual void	SetTexture (int iTextureUnitIndex, RageTexture *pTexture)=0
virtual void	SetTextureModeModulate ()=0
virtual void	SetTextureModeGlow ()=0
virtual void	SetTextureModeAdd ()=0
virtual void	SetTextureWrapping (bool b)=0
virtual int	GetMaxTextureSize () const =0
virtual void	SetTextureFiltering (bool b)=0
virtual bool	IsZTestEnabled () const =0
virtual bool	IsZWriteEnabled () const =0
virtual void	SetZWrite (bool b)=0
virtual void	SetZTestMode (ZTestMode mode)=0
virtual void	ClearZBuffer ()=0
virtual void	SetCullMode (CullMode mode)=0
virtual void	SetAlphaTest (bool b)=0
virtual void	SetMaterial (const RageColor &emissive, const RageColor &ambient, const RageColor &diffuse, const RageColor &specular, float shininess)=0
virtual void	SetLighting (bool b)=0
virtual void	SetLightOff (int index)=0
virtual void	SetLightDirectional (int index, const RageColor &ambient, const RageColor &diffuse, const RageColor &specular, const RageVector3 &dir)=0
virtual void	SetSphereEnvironmentMapping (bool b)=0
virtual RageCompiledGeometry *	CreateCompiledGeometry ()=0
virtual void	DeleteCompiledGeometry (RageCompiledGeometry *p)=0
void	DrawQuads (const RageSpriteVertex v[], int iNumVerts)
void	DrawQuadStrip (const RageSpriteVertex v[], int iNumVerts)
void	DrawFan (const RageSpriteVertex v[], int iNumVerts)
void	DrawStrip (const RageSpriteVertex v[], int iNumVerts)
void	DrawTriangles (const RageSpriteVertex v[], int iNumVerts)
void	DrawCompiledGeometry (const RageCompiledGeometry *p, int iMeshIndex, const vector< msMesh > &vMeshes)
void	DrawLineStrip (const RageSpriteVertex v[], int iNumVerts, float LineWidth)
void	DrawCircle (const RageSpriteVertex &v, float radius)
void	DrawQuad (const RageSpriteVertex v[])
virtual void	SetPolygonMode (PolygonMode pm)
virtual void	SetLineWidth (float fWidth)
bool	SaveScreenshot (CString sPath, GraphicsFileFormat format)
virtual CString	GetTextureDiagnostics (unsigned id) const
virtual RageSurface *	CreateScreenshot ()=0
int	GetFPS () const
int	GetVPF () const
int	GetCumFPS () const
virtual void	ResetStats ()
virtual void	ProcessStatsOnFlip ()
virtual CString	GetStats () const
void	StatsAddVerts (int iNumVertsRendered)
void	PushMatrix ()
void	PopMatrix ()
void	Translate (float x, float y, float z)
void	TranslateWorld (float x, float y, float z)
void	Scale (float x, float y, float z)
void	RotateX (float deg)
void	RotateY (float deg)
void	RotateZ (float deg)
void	MultMatrix (const RageMatrix &f)
void	PostMultMatrix (const RageMatrix &f)
void	PreMultMatrix (const RageMatrix &f)
void	LoadIdentity ()
void	TexturePushMatrix ()
void	TexturePopMatrix ()
void	TextureTranslate (float x, float y, float z)
void	CameraPushMatrix ()
void	CameraPopMatrix ()
void	LoadMenuPerspective (float fovDegrees, float fVanishPointX, float fVanishPointY)
void	LoadLookAt (float fov, const RageVector3 &Eye, const RageVector3 &At, const RageVector3 &Up)
void	ChangeCentering (int trans_x, int trans_y, int add_width, int add_height)
RageSurface *	CreateSurfaceFromPixfmt (PixelFormat pixfmt, void *pixels, int width, int height, int pitch)
PixelFormat	FindPixelFormat (int bpp, int Rmask, int Gmask, int Bmask, int Amask, bool realtime=false)
Static Public Member Functions
CString	PixelFormatToString (PixelFormat pixfmt)
Protected Member Functions
virtual void	DrawQuadsInternal (const RageSpriteVertex v[], int iNumVerts)=0
virtual void	DrawQuadStripInternal (const RageSpriteVertex v[], int iNumVerts)=0
virtual void	DrawFanInternal (const RageSpriteVertex v[], int iNumVerts)=0
virtual void	DrawStripInternal (const RageSpriteVertex v[], int iNumVerts)=0
virtual void	DrawTrianglesInternal (const RageSpriteVertex v[], int iNumVerts)=0
virtual void	DrawCompiledGeometryInternal (const RageCompiledGeometry *p, int iMeshIndex)=0
virtual void	DrawLineStripInternal (const RageSpriteVertex v[], int iNumVerts, float LineWidth)
virtual void	DrawCircleInternal (const RageSpriteVertex &v, float radius)
virtual CString	TryVideoMode (VideoModeParams params, bool &bNewDeviceOut)=0
virtual void	SetViewport (int shift_left, int shift_down)=0
void	DrawPolyLine (const RageSpriteVertex &p1, const RageSpriteVertex &p2, float LineWidth)
void	SetDefaultRenderStates ()
RageMatrix	GetPerspectiveMatrix (float fovy, float aspect, float zNear, float zFar)
virtual RageMatrix	GetOrthoMatrix (float l, float r, float b, float t, float zn, float zf)
virtual RageMatrix	GetFrustumMatrix (float l, float r, float b, float t, float zn, float zf)
const RageMatrix *	GetCentering ()
const RageMatrix *	GetProjectionTop ()
const RageMatrix *	GetViewTop ()
const RageMatrix *	GetWorldTop ()
const RageMatrix *	GetTextureTop ()
Protected Attributes
RageMatrix	m_Centering

---

Member Enumeration Documentation

enum RageDisplay::GraphicsFileFormat

Enumeration values: SAVE_LOSSLESS  SAVE_LOSSY_LOW_QUAL  SAVE_LOSSY_HIGH_QUAL

enum RageDisplay::PixelFormat

Enumeration values: FMT_RGBA8  FMT_RGBA4  FMT_RGB5A1  FMT_RGB5  FMT_RGB8  FMT_PAL  FMT_BGR8  FMT_A1BGR5  NUM_PIX_FORMATS

---

Constructor & Destructor Documentation

virtual RageDisplay::~RageDisplay (   )  [inline, virtual]

---

Member Function Documentation

virtual bool RageDisplay::BeginFrame (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::CameraPopMatrix (   )

void RageDisplay::CameraPushMatrix (   )

void RageDisplay::ChangeCentering (  int  trans_x, int  trans_y, int  add_width, int  add_height )

virtual void RageDisplay::ClearAllTextures (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::ClearZBuffer (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual RageCompiledGeometry* RageDisplay::CreateCompiledGeometry (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual RageSurface* RageDisplay::CreateScreenshot (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

RageSurface * RageDisplay::CreateSurfaceFromPixfmt (  PixelFormat  pixfmt, void *  pixels, int  width, int  height, int  pitch )

virtual unsigned RageDisplay::CreateTexture (  PixelFormat  pixfmt, RageSurface *  img, bool  bGenerateMipMaps )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::DeleteCompiledGeometry (  RageCompiledGeometry *  p  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::DeleteTexture (  unsigned  uTexHandle  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawCircle (  const RageSpriteVertex &  v, float  radius )

void RageDisplay::DrawCircleInternal (  const RageSpriteVertex &  v, float  radius )  [protected, virtual]

void RageDisplay::DrawCompiledGeometry (  const RageCompiledGeometry *  p, int  iMeshIndex, const vector< msMesh > &  vMeshes )

virtual void RageDisplay::DrawCompiledGeometryInternal (  const RageCompiledGeometry *  p, int  iMeshIndex )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawFan (  const RageSpriteVertex  v[], int  iNumVerts )

virtual void RageDisplay::DrawFanInternal (  const RageSpriteVertex  v[], int  iNumVerts )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawLineStrip (  const RageSpriteVertex  v[], int  iNumVerts, float  LineWidth )

void RageDisplay::DrawLineStripInternal (  const RageSpriteVertex  v[], int  iNumVerts, float  LineWidth )  [protected, virtual]

Reimplemented in RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawPolyLine (  const RageSpriteVertex &  p1, const RageSpriteVertex &  p2, float  LineWidth )  [protected]

void RageDisplay::DrawQuad (  const RageSpriteVertex  v[]  )  [inline]

void RageDisplay::DrawQuads (  const RageSpriteVertex  v[], int  iNumVerts )

virtual void RageDisplay::DrawQuadsInternal (  const RageSpriteVertex  v[], int  iNumVerts )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawQuadStrip (  const RageSpriteVertex  v[], int  iNumVerts )

virtual void RageDisplay::DrawQuadStripInternal (  const RageSpriteVertex  v[], int  iNumVerts )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawStrip (  const RageSpriteVertex  v[], int  iNumVerts )

virtual void RageDisplay::DrawStripInternal (  const RageSpriteVertex  v[], int  iNumVerts )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::DrawTriangles (  const RageSpriteVertex  v[], int  iNumVerts )

virtual void RageDisplay::DrawTrianglesInternal (  const RageSpriteVertex  v[], int  iNumVerts )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::EndFrame (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

RageDisplay::PixelFormat RageDisplay::FindPixelFormat (  int  bpp, int  Rmask, int  Gmask, int  Bmask, int  Amask, bool  realtime = false )

const RageMatrix* RageDisplay::GetCentering (   )  [inline, protected]

int RageDisplay::GetCumFPS (   )  const

int RageDisplay::GetFPS (   )  const

RageMatrix RageDisplay::GetFrustumMatrix (  float  l, float  r, float  b, float  t, float  zn, float  zf )  [protected, virtual]

virtual int RageDisplay::GetMaxTextureSize (   )  const [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual int RageDisplay::GetNumTextureUnits (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

RageMatrix RageDisplay::GetOrthoMatrix (  float  l, float  r, float  b, float  t, float  zn, float  zf )  [protected, virtual]

Reimplemented in RageDisplay_D3D, and RageDisplay_Null.

RageMatrix RageDisplay::GetPerspectiveMatrix (  float  fovy, float  aspect, float  zNear, float  zFar )  [protected]

virtual const PixelFormatDesc* RageDisplay::GetPixelFormatDesc (  PixelFormat  pf  )  const [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

const RageMatrix * RageDisplay::GetProjectionTop (   )  [protected]

CString RageDisplay::GetStats (   )  const [virtual]

virtual CString RageDisplay::GetTextureDiagnostics (  unsigned  id  )  const [inline, virtual]

Reimplemented in RageDisplay_OGL.

const RageMatrix * RageDisplay::GetTextureTop (   )  [protected]

virtual VideoModeParams RageDisplay::GetVideoModeParams (   )  const [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

const RageMatrix * RageDisplay::GetViewTop (   )  [protected]

int RageDisplay::GetVPF (   )  const

const RageMatrix * RageDisplay::GetWorldTop (   )  [protected]

bool RageDisplay::IsWindowed (   )  const [inline]

virtual bool RageDisplay::IsZTestEnabled (   )  const [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual bool RageDisplay::IsZWriteEnabled (   )  const [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::LoadIdentity (   )

void RageDisplay::LoadLookAt (  float  fov, const RageVector3 &  Eye, const RageVector3 &  At, const RageVector3 &  Up )

void RageDisplay::LoadMenuPerspective (  float  fovDegrees, float  fVanishPointX, float  fVanishPointY )

void RageDisplay::MultMatrix (  const RageMatrix &  f  )  [inline]

CString RageDisplay::PixelFormatToString (  PixelFormat  pixfmt  )  [static]

void RageDisplay::PopMatrix (   )

void RageDisplay::PostMultMatrix (  const RageMatrix &  f  )

void RageDisplay::PreMultMatrix (  const RageMatrix &  f  )

void RageDisplay::ProcessStatsOnFlip (   )  [virtual]

void RageDisplay::PushMatrix (   )

void RageDisplay::ResetStats (   )  [virtual]

virtual void RageDisplay::ResolutionChanged (   )  [inline, virtual]

Reimplemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::RotateX (  float  deg  )

void RageDisplay::RotateY (  float  deg  )

void RageDisplay::RotateZ (  float  deg  )

bool RageDisplay::SaveScreenshot (  CString  sPath, GraphicsFileFormat  format )

void RageDisplay::Scale (  float  x, float  y, float  z )

virtual void RageDisplay::SetAlphaTest (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetBlendMode (  BlendMode  mode  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetCullMode (  CullMode  mode  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::SetDefaultRenderStates (   )  [protected]

virtual void RageDisplay::SetLightDirectional (  int  index, const RageColor &  ambient, const RageColor &  diffuse, const RageColor &  specular, const RageVector3 &  dir )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetLighting (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetLightOff (  int  index  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetLineWidth (  float  fWidth  )  [inline, virtual]

Reimplemented in RageDisplay_OGL.

virtual void RageDisplay::SetMaterial (  const RageColor &  emissive, const RageColor &  ambient, const RageColor &  diffuse, const RageColor &  specular, float  shininess )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetPolygonMode (  PolygonMode  pm  )  [inline, virtual]

Reimplemented in RageDisplay_OGL.

virtual void RageDisplay::SetSphereEnvironmentMapping (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTexture (  int  iTextureUnitIndex, RageTexture *  pTexture )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTextureFiltering (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTextureModeAdd (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTextureModeGlow (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTextureModeModulate (   )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetTextureWrapping (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

CString RageDisplay::SetVideoMode (  VideoModeParams  p, bool &  bNeedReloadTextures )

virtual void RageDisplay::SetViewport (  int  shift_left, int  shift_down )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetZTestMode (  ZTestMode  mode  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::SetZWrite (  bool  b  )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::StatsAddVerts (  int  iNumVertsRendered  )

virtual bool RageDisplay::SupportsTextureFormat (  PixelFormat  pixfmt, bool  realtime = false )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

void RageDisplay::TexturePopMatrix (   )

void RageDisplay::TexturePushMatrix (   )

void RageDisplay::TextureTranslate (  float  x, float  y, float  z )

void RageDisplay::Translate (  float  x, float  y, float  z )

void RageDisplay::TranslateWorld (  float  x, float  y, float  z )

virtual CString RageDisplay::TryVideoMode (  VideoModeParams  params, bool &  bNewDeviceOut )  [protected, pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::Update (  float  fDeltaTime  )  [inline, virtual]

Reimplemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

virtual void RageDisplay::UpdateTexture (  unsigned  uTexHandle, RageSurface *  img, int  xoffset, int  yoffset, int  width, int  height )  [pure virtual]

Implemented in RageDisplay_D3D, RageDisplay_Null, and RageDisplay_OGL.

---

Member Data Documentation

RageMatrix RageDisplay::m_Centering [protected]

---

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

• RageDisplay.h
• RageDisplay.cpp

---