Contents Functions Classes Topics User Forum CVS

G3D::RenderDevice Class Reference

#include <RenderDevice.h>

Detailed Description

You must call RenderDevice::init() before using the RenderDevice.

Rendering interface that abstracts OpenGL. OpenGL is a basically good API with some rough spots. Three of these are addressed by RenderDevice. First, OpenGL state management is both tricky and potentially slow. Second, OpenGL functions are difficult to use because many extensions have led to an evolutionary rather than designed API. For type safety, new enums are introduced for values instead of the traditional OpenGL GLenum's, which are just ints. Third, OpenGL intialization is complicated. This interface simplifies it significantly.

NICEST line and point smoothing is enabled by default (however, you need to set your alpha blending mode to see it).

glEnable(GL_NORMALIZE) is set by default. glEnable(GL_COLOR_MATERIAL) is enabled by default. You may be able to get a slight speed increase by disabling GL_NORMALIZE or using GL_SCALE_NORMAL instead.

For stereo rendering, set GWindow::Settings::stereo = true and use RenderDevice::setDrawBuffer to switch which eye is being rendered. Only use RenderDevice::beginFrame/RenderDeviceendFrame once per frame, but do clear both buffers separately.

The only OpenGL calls NOT abstracted by RenderDevice are fog and texture coordinate generation. For everything else, use RenderDevice.

Example

   RenderDevice renderDevice = new RenderDevice();
   renderDevice->init(GWindow::Settings());

Example 2 (textured quad)

    RenderDevice* renderDevice = new RenderDevice();
    renderDevice->init(640, 480);

    TextureRef sprite = new Texture("Grass Texture", "image.jpg");

    renderDevice->beginFrame();
    renderDevice->pushState();
    renderDevice->clear(true, true, true);
    renderDevice->setCullFace(RenderDevice::CULL_NONE);
    renderDevice->setProjectionMatrix(Matrix4::perspectiveProjection(-.2, .2, -.15, .15, .2, 200));
    renderDevice->setTexture(0, sprite);
    renderDevice->setColor(Color3::white());
    renderDevice->beginPrimitive(RenderDevice::QUADS);
        renderDevice->setTexCoord(0,  Vector2(0, 1));
        renderDevice->sendVertex(Vector3(-3, -3, -5));

        renderDevice->setTexCoord(0,  Vector2(1, 1));
        renderDevice->sendVertex(Vector3( 3, -3, -5));

        renderDevice->setTexCoord(0,  Vector2(1, 0));
        renderDevice->sendVertex(Vector3( 3,  3, -5));

        renderDevice->setTexCoord(0,  Vector2(0, 0));
        renderDevice->sendVertex(Vector3(-3,  3, -5));
    renderDevice->endPrimitive();
    renderDevice->popState();

    renderDevice->endFrame();

    while (true);

    renderDevice->cleanup();

G3D::RenderDevice supports "X_CURRENT" as an option for most settings.

Stereo Rendering You can render in stereo (on a stereo capable card) by rendering twice, once for each eye's buffer:

    void doGraphics() {
        glDrawBuffer(GL_BACK_LEFT); 
        for (int count = 0; count < 2; ++count) {
           ... (put your normal rendering code here)
           glDrawBuffer(GL_BACK_RIGHT);
        }
    }

Multiple displays If you are using multiple synchronized displays (e.g. the CAVE), see: http://www.nvidia.com/object/IO_10753.html and http://www.cs.unc.edu/Research/stc/FAQs/nVidia/FrameLock-V1.0C.pdf

GLCaps loads the relevant extensions for you, but you must make the synchronizing calls yourself (typically, immediately before you call swap buffers).

Raw OpenGL Calls RenderDevice allows you to mix your own OpenGL calls with RenderDevice calls. It assumes that you restored the OpenGL state after your OpenGL calls, however. It is not safe to mix arbitrary OpenGL calls with Shaders, however. The G3D::Shader API supports more features than OpenGL shaders and does not work well with low-level OpenGL. You may find that the "wrong" shader is bound when you execute OpenGL calls.

Member Enumeration Documentation

anonymous enum

Enumerator:

MAX_LIGHTS

enum G3D::RenderDevice::AlphaTest

Enumerator:

ALPHA_GREATER

ALPHA_LESS

ALPHA_GEQUAL

ALPHA_LEQUAL

ALPHA_NOTEQUAL

ALPHA_EQUAL

ALPHA_ALWAYS_PASS

ALPHA_NEVER_PASS

ALPHA_CURRENT

enum G3D::RenderDevice::BlendEq

Enumerator:

BLENDEQ_MIN

BLENDEQ_MAX

BLENDEQ_ADD

BLENDEQ_SUBTRACT

BLENDEQ_REVERSE_SUBTRACT

BLENDEQ_CURRENT

enum G3D::RenderDevice::BlendFunc

Enumerator:

BLEND_SRC_ALPHA

BLEND_ONE_MINUS_SRC_ALPHA

BLEND_ONE

BLEND_ZERO

BLEND_SRC_COLOR

BLEND_DST_COLOR

BLEND_ONE_MINUS_SRC_COLOR

BLEND_CURRENT

enum G3D::RenderDevice::Buffer

Enumerator:

BUFFER_NONE

BUFFER_FRONT_LEFT

BUFFER_FRONT_RIGHT

BUFFER_BACK_LEFT

BUFFER_BACK_RIGHT

BUFFER_FRONT

BUFFER_BACK

BUFFER_LEFT

BUFFER_RIGHT

BUFFER_FRONT_AND_BACK

BUFFER_CURRENT

BUFFER_COLOR0

BUFFER_COLOR1

BUFFER_COLOR2

BUFFER_COLOR3

BUFFER_COLOR4

BUFFER_COLOR5

BUFFER_COLOR6

BUFFER_COLOR7

BUFFER_COLOR8

BUFFER_COLOR9

BUFFER_COLOR10

BUFFER_COLOR11

BUFFER_COLOR12

BUFFER_COLOR13

BUFFER_COLOR14

BUFFER_COLOR15

enum G3D::RenderDevice::CombineMode

Arguments to setTextureCombineMode
TEX_INTERPOLATE = GL_DECAL (blend between previous and current texture based on current alpha)
Note: GL_INTERPOLATE_ARB is not supported because it takes two arguments. You can access it yourself using glTexEnvi.
TEX_BLEND = GL_BLEND (for luminance textures, blend against a constant)
TEX_ADD is only present if GLCaps::supports("GL_EXT_texture_env_add") See http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_add.txt
TEX_ADD_SIGNED and TEX_SUBTRACT are only present if GLCaps::supports("GL_ARB_texture_env_combine") See http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_combine.txt
TEX_DOT3_RGB and TEX_DOT3_RGBA are only present if GLCaps::supports("GL_ARB_texture_env_dot3") http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_dot3.txt
Enumerator:

TEX_REPLACE

TEX_BLEND

TEX_INTERPOLATE

TEX_ADD

TEX_MODULATE

TEX_ADD_SIGNED

TEX_SUBTRACT

TEX_DOT3_RGB

TEX_DOT3_RGBA

TEX_CURRENT

enum G3D::RenderDevice::CullFace

Enumerator:

CULL_FRONT

CULL_BACK

CULL_NONE

CULL_CURRENT

enum G3D::RenderDevice::DepthTest

Enumerator:

DEPTH_GREATER

DEPTH_LESS

DEPTH_GEQUAL

DEPTH_LEQUAL

DEPTH_NOTEQUAL

DEPTH_EQUAL

DEPTH_ALWAYS_PASS

DEPTH_NEVER_PASS

DEPTH_CURRENT

enum G3D::RenderDevice::Primitive

Enumerator:

LINES

LINE_STRIP

TRIANGLES

TRIANGLE_STRIP

TRIANGLE_FAN

QUADS

QUAD_STRIP

POINTS

enum G3D::RenderDevice::RenderMode

RENDER_CURRENT = preserve whatever the render mode is currently set to.
Enumerator:

RENDER_SOLID

RENDER_WIREFRAME

RENDER_POINTS

RENDER_CURRENT

enum G3D::RenderDevice::ShadeMode

Enumerator:

SHADE_FLAT

SHADE_SMOOTH

SHADE_CURRENT

enum G3D::RenderDevice::StencilOp

Enumerator:

STENCIL_INCR_WRAP

STENCIL_DECR_WRAP

STENCIL_KEEP

STENCIL_INCR

STENCIL_DECR

STENCIL_REPLACE

STENCIL_ZERO

STENCIL_INVERT

STENCILOP_CURRENT

enum G3D::RenderDevice::StencilTest

Enumerator:

STENCIL_GREATER

STENCIL_LESS

STENCIL_GEQUAL

STENCIL_LEQUAL

STENCIL_NOTEQUAL

STENCIL_EQUAL

STENCIL_ALWAYS_PASS

STENCIL_NEVER_PASS

STENCIL_CURRENT

Constructor & Destructor Documentation

G3D::RenderDevice::RenderDevice ( )

G3D::RenderDevice::~RenderDevice ( )

Member Function Documentation

void G3D::RenderDevice::afterPrimitive ( )

Automatically called immediately after a primitive group. See also beforePrimitive.

AlphaTest G3D::RenderDevice::alphaTest ( ) const

double G3D::RenderDevice::alphaTestReference ( ) const

bool G3D::RenderDevice::alphaWrite ( ) const

Returns true if alphaWrite is enabled

G3D::RenderDevice Class Reference

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Friends

Classes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation