Tgl::Renderer Class Reference

[AI] Main interface/factory for rendering resources and scene graphs. More...

#include <tgl.h>

Inheritance diagram for Tgl::Renderer:

Collaboration diagram for Tgl::Renderer:

Public Member Functions
virtual Device *	CreateDevice (const DeviceDirectDrawCreateData &)=0
	[AI] Creates a rendering device using DirectDraw parameters. More...
virtual Device *	CreateDevice (const DeviceDirect3DCreateData &)=0
	[AI] Creates a rendering device using Direct3D parameters. More...
virtual View *	CreateView (const Device *, const Camera *, unsigned long x, unsigned long y, unsigned long width, unsigned long height)=0
	[AI] Creates a rendering view associated with the given device and camera. More...
virtual Camera *	CreateCamera ()=0
	[AI] Creates a new camera. More...
virtual Light *	CreateLight (LightType, float r, float g, float b)=0
	[AI] Creates a new light of the given type and color. More...
virtual Group *	CreateGroup (const Group *pParent=0)=0
	[AI] Creates a new group (scene graph node), optionally parented. More...
virtual MeshBuilder *	CreateMeshBuilder ()=0
	[AI] Creates a new mesh builder. More...
virtual Texture *	CreateTexture (int width, int height, int bitsPerTexel, const void *pTexels, int pTexelsArePersistent, int paletteEntryCount, const PaletteEntry *pEntries)=0
	[AI] Creates a new texture from raw texel buffer and optional palette. More...
virtual Texture *	CreateTexture ()=0
	[AI] Creates an (empty) texture. More...
virtual Result	SetTextureDefaultShadeCount (unsigned long)=0
	[AI] Sets the default number of shades to generate for textures. More...
virtual Result	SetTextureDefaultColorCount (unsigned long)=0
	[AI] Sets the default number of colors to use for textures (likely palette size). More...
Public Member Functions inherited from Tgl::Object
virtual	~Object ()
	[AI] Destructor; releases resources. More...
virtual void *	ImplementationDataPtr ()=0
	[AI] Returns a pointer to internal/implementation data, if any. More...

Detailed Description

[AI] Main interface/factory for rendering resources and scene graphs.

[AI]

[AI] Instantiated to provide devices, views, geometries, textures, lights, and cameras. [AI]

Definition at line 188 of file tgl.h.

Member Function Documentation

CreateCamera()

virtual Camera * Tgl::Renderer::CreateCamera ( )

pure virtual

[AI] Creates a new camera.

[AI]

Returns

Camera* Newly created camera. [AI]

Implemented in TglImpl::RendererImpl.

CreateDevice() [1/2]

virtual Device * Tgl::Renderer::CreateDevice ( const DeviceDirect3DCreateData &  )

pure virtual

[AI] Creates a rendering device using Direct3D parameters.

[AI]

Parameters

param

Creation parameters (Direct3D). [AI]

Returns

Device* Device object or nullptr on failure. [AI]

Implemented in TglImpl::RendererImpl.

CreateDevice() [2/2]

virtual Device * Tgl::Renderer::CreateDevice ( const DeviceDirectDrawCreateData &  )

pure virtual

[AI] Creates a rendering device using DirectDraw parameters.

[AI]

Parameters

param

Creation parameters (DirectDraw). [AI]

Returns

Device* Device object or nullptr on failure. [AI]

Implemented in TglImpl::RendererImpl.

CreateGroup()

virtual Group * Tgl::Renderer::CreateGroup ( const Group *  pParent = 0 )

pure virtual

[AI] Creates a new group (scene graph node), optionally parented.

[AI]

Parameters

pParent

Optional parent group (may be nullptr). [AI]

Returns

Group* New group object. [AI]

Implemented in TglImpl::RendererImpl.

CreateLight()

virtual Light * Tgl::Renderer::CreateLight ( LightType  , float  r, float  g, float  b  )

pure virtual

[AI] Creates a new light of the given type and color.

[AI]

Parameters

type	Type of light. [AI]
r	Red value. [AI]
g	Green value. [AI]
b	Blue value. [AI]

Returns

Light* Created light object. [AI]

Implemented in TglImpl::RendererImpl.

CreateMeshBuilder()

virtual MeshBuilder * Tgl::Renderer::CreateMeshBuilder ( )

pure virtual

[AI] Creates a new mesh builder.

[AI]

Returns

MeshBuilder* For mesh creation and construction. [AI]

Implemented in TglImpl::RendererImpl.

CreateTexture() [1/2]

virtual Texture * Tgl::Renderer::CreateTexture ( )

pure virtual

[AI] Creates an (empty) texture.

[AI]

Returns

Texture* Created texture object. [AI]

Implemented in TglImpl::RendererImpl.

CreateTexture() [2/2]

virtual Texture * Tgl::Renderer::CreateTexture ( int  width, int  height, int  bitsPerTexel, const void *  pTexels, int  pTexelsArePersistent, int  paletteEntryCount, const PaletteEntry *  pEntries  )

pure virtual

[AI] Creates a new texture from raw texel buffer and optional palette.

[AI]

Parameters

width	Texture width. [AI]
height	Texture height. [AI]
bitsPerTexel	Bit depth of each texel. [AI]
pTexels	Texel buffer. [AI]
pTexelsArePersistent	Whether texels are persistent in memory. [AI]
paletteEntryCount	Size of the palette. [AI]
pEntries	Palette entries. [AI]

Returns

Texture* Created texture. [AI]

Implemented in TglImpl::RendererImpl.

CreateView()

virtual View * Tgl::Renderer::CreateView ( const Device *  , const Camera *  , unsigned long  x, unsigned long  y, unsigned long  width, unsigned long  height  )

pure virtual

[AI] Creates a rendering view associated with the given device and camera.

[AI]

Parameters

device	Rendering device. [AI]
camera	Associated camera. [AI]
x	View X position. [AI]
y	View Y position. [AI]
width	Viewport width. [AI]
height	Viewport height. [AI]

Returns

View* View object or nullptr. [AI]

Implemented in TglImpl::RendererImpl.

SetTextureDefaultColorCount()

virtual Result Tgl::Renderer::SetTextureDefaultColorCount ( unsigned long  )

pure virtual

[AI] Sets the default number of colors to use for textures (likely palette size).

[AI]

Parameters

count

Color count. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::RendererImpl.

SetTextureDefaultShadeCount()

virtual Result Tgl::Renderer::SetTextureDefaultShadeCount ( unsigned long  )

pure virtual

[AI] Sets the default number of shades to generate for textures.

[AI]

Parameters

count

Number of shades. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::RendererImpl.

---

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

• tgl.h