Renderer Struct Reference

The Renderer is responsible for rasterizing the View hierarchy of a WindowController. More...

#include <Renderer.h>

Inheritance diagram for Renderer:

Public Member Functions
Class *	_Renderer (void)
	The Renderer archetype. More...
void	beginFrame (Renderer *self)
	Sets up OpenGL state. More...
GLuint	createTexture (const Renderer *self, const SDL_Surface *surface)
	Generates and binds to an OpenGL texture object, uploading the given surface. More...
void	drawLine (const Renderer *self, const SDL_Point *points)
	Draws a line segment between two points using GL_LINE_STRIP. More...
void	drawLines (const Renderer *self, const SDL_Point *points, size_t count)
	Draws line segments between adjacent points using GL_LINE_STRIP. More...
void	drawRect (const Renderer *self, const SDL_Rect *rect)
	Draws a rectangle using GL_LINE_LOOP. More...
void	drawRectFilled (const Renderer *self, const SDL_Rect *rect)
	Fills a rectangle using glRecti. More...
void	drawTexture (const Renderer *self, GLuint texture, const SDL_Rect *dest)
	Draws a textured GL_QUAD in the given rectangle. More...
void	drawView (Renderer *self, View *view)
	Draws the given View, setting the clipping frame and invoking View::render. More...
void	endFrame (const Renderer *self)
	Resets OpenGL state. Does not swap buffers. More...
void	endFrame (Renderer *self)
Renderer *	init (Renderer *self)
	Initializes this Renderer. More...
void	renderDeviceDidReset (Renderer *self)
	This method is invoked when the render device has reset. More...
void	renderDeviceWillReset (Renderer *self)
	This method is invoked when the render device will become reset. More...
void	setClippingFrame (Renderer *self, const SDL_Rect *clippingFrame)
	Sets the clipping frame for draw operations. More...
void	setDrawColor (Renderer *self, const SDL_Color *color)
	Sets the primary color for drawing operations. More...

Data Fields
Object	object
	The superclass. More...

Protected Attributes
RendererInterface *	interface
	The interface. More...

Detailed Description

The Renderer is responsible for rasterizing the View hierarchy of a WindowController.

This class provides an OpenGL 1.x implementation of the RendererInterface. Applications may extend this class and provide an implementation that meets their own OpenGL version requirements.

Definition at line 50 of file Renderer.h.

Member Function Documentation

_Renderer()

Class * _Renderer

(

void

)

The Renderer archetype.

Returns

The Renderer Class.

Definition at line 312 of file Renderer.c.

                       {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Renderer",
            .superclass = _Object(),
            .instanceSize = sizeof(Renderer),
            .interfaceOffset = offsetof(Renderer, interface),
            .interfaceSize = sizeof(RendererInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

beginFrame()

void beginFrame

(

Renderer *

self

)

Sets up OpenGL state.

Parameters

self	The Renderer.

Remarks

This method is called by the WindowController to begin rendering. Override this method for custom OpenGL state setup, if desired.

Definition at line 39 of file Renderer.c.

                                       {
 
    glEnable(GL_BLEND);
    glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 
    glEnable(GL_SCISSOR_TEST);
 
    glEnableClientState(GL_VERTEX_ARRAY);
    glEnableClientState(GL_TEXTURE_COORD_ARRAY);
 
    $(self, setDrawColor, &Colors.White);
}

createTexture()

GLuint createTexture	(	const Renderer *	self,
		const SDL_Surface *	surface
	)

Generates and binds to an OpenGL texture object, uploading the given surface.

Parameters

self	The Renderer.
surface	The surface.

Returns

The OpenGL texture name, or 0 on error.

Definition at line 56 of file Renderer.c.

                                                                              {
 
    assert(surface);
 
    GLenum format;
    switch (surface->format->BytesPerPixel) {
        case 1:
            format = GL_LUMINANCE;
            break;
        case 3:
            format = GL_RGB;
            break;
        case 4:
            format = GL_RGBA;
            break;
        default:
            MVC_LogError("Invalid surface format: %s\n", SDL_GetPixelFormatName(surface->format->format));
            return 0;
    }
 
    GLuint texture;
    glGenTextures(1, &texture);
 
    glBindTexture(GL_TEXTURE_2D, texture);
 
    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
    glTexParameteri(GL_TEXTURE_2D, GL_GENERATE_MIPMAP, GL_FALSE);
 
    glTexImage2D(GL_TEXTURE_2D, 0, format, surface->w, surface->h, 0, format, GL_UNSIGNED_BYTE, surface->pixels);
 
    return texture;
}

drawLine()

void drawLine	(	const Renderer *	self,
		const SDL_Point *	points
	)

Draws a line segment between two points using GL_LINE_STRIP.

Parameters

self	The Renderer.
points	The points.

Definition at line 94 of file Renderer.c.

                                                                    {
 
    assert(points);
 
    $(self, drawLines, points, 2);
}

drawLines()

void drawLines	(	const Renderer *	self,
		const SDL_Point *	points,
		size_t	count
	)

Draws line segments between adjacent points using GL_LINE_STRIP.

Parameters

self	The Renderer.
points	The points.
count	The length of points.

Definition at line 105 of file Renderer.c.

                                                                                   {
 
    assert(points);
 
    glVertexPointer(2, GL_INT, 0, points);
 
    glDrawArrays(GL_LINE_STRIP, 0, (GLsizei) count);
}

drawRect()

void drawRect	(	const Renderer *	self,
		const SDL_Rect *	rect
	)

Draws a rectangle using GL_LINE_LOOP.

Parameters

self	The Renderer.
rect	The rectangle.

Definition at line 118 of file Renderer.c.

                                                                 {
 
    assert(rect);
 
    GLint verts[8];
 
    verts[0] = rect->x;
    verts[1] = rect->y;
 
    verts[2] = rect->x + rect->w;
    verts[3] = rect->y;
 
    verts[4] = rect->x + rect->w;
    verts[5] = rect->y + rect->h;
 
    verts[6] = rect->x;
    verts[7] = rect->y + rect->h;
 
    glVertexPointer(2, GL_INT, 0, verts);
    glDrawArrays(GL_LINE_LOOP, 0, 4);
}

drawRectFilled()

void drawRectFilled	(	const Renderer *	self,
		const SDL_Rect *	rect
	)

Fills a rectangle using glRecti.

Parameters

self	The Renderer.
rect	The rectangle.

Definition at line 144 of file Renderer.c.

                                                                       {
 
    assert(rect);
 
    glRecti(rect->x - 1, rect->y - 1, rect->x + rect->w + 1, rect->y + rect->h + 1);
}

drawTexture()

void drawTexture	(	const Renderer *	self,
		GLuint	texture,
		const SDL_Rect *	dest
	)

Draws a textured GL_QUAD in the given rectangle.

Parameters

self	The Renderer.
texture	The texture.
dest	The destination in screen coordinates.

Definition at line 155 of file Renderer.c.

                                                                                    {
 
    assert(rect);
 
    const GLfloat texcoords[] = {
        0.0, 0.0,
        1.0, 0.0,
        1.0, 1.0,
        0.0, 1.0
    };
 
    GLint verts[8];
 
    verts[0] = rect->x;
    verts[1] = rect->y;
 
    verts[2] = rect->x + rect->w;
    verts[3] = rect->y;
 
    verts[4] = rect->x + rect->w;
    verts[5] = rect->y + rect->h;
 
    verts[6] = rect->x;
    verts[7] = rect->y + rect->h;
 
    glEnable(GL_TEXTURE_2D);
    glBindTexture(GL_TEXTURE_2D, texture);
 
    glVertexPointer(2, GL_INT, 0, verts);
    glTexCoordPointer(2, GL_FLOAT, 0, texcoords);
 
    glDrawArrays(GL_QUADS, 0, 4);
 
    glDisable(GL_TEXTURE_2D);
}

drawView()

void drawView	(	Renderer *	self,
		View *	view
	)

Draws the given View, setting the clipping frame and invoking View::render.

Parameters

self	The Renderer.
view	The View.

Definition at line 195 of file Renderer.c.

                                                 {
 
    assert(view);
 
    const SDL_Rect clippingFrame = $(view, clippingFrame);
    if (clippingFrame.w && clippingFrame.h) {
 
        $(self, setClippingFrame, &clippingFrame);
 
        $(view, render, self);
    }
}

endFrame() [1/2]

void endFrame

(

const Renderer *

self

)

Resets OpenGL state. Does not swap buffers.

Parameters

self	The Renderer.

Remarks

This method is called by the WindowController to end rendering. Override this method for custom OpenGL state teardown, if desired.

endFrame() [2/2]

void endFrame

(

Renderer *

self

)

Definition at line 212 of file Renderer.c.

                                     {
 
    $(self, setDrawColor, &Colors.White);
 
    glDisableClientState(GL_VERTEX_ARRAY);
    glDisableClientState(GL_TEXTURE_COORD_ARRAY);
 
    $(self, setClippingFrame, NULL);
 
    glDisable(GL_SCISSOR_TEST);
 
    glBlendFunc(GL_ONE, GL_ZERO);
    glDisable(GL_BLEND);
 
    const GLenum err = glGetError();
    if (err) {
        MVC_LogError("GL error: %d\n", err);
    }
}

init()

Renderer * init

(

Renderer *

self

)

Initializes this Renderer.

Parameters

self	The Renderer.

Returns

The initialized Renderer, or NULL on error.

Definition at line 236 of file Renderer.c.

                                      {
    return (Renderer *) super(Object, self, init);
}

renderDeviceDidReset()

void renderDeviceDidReset

(

Renderer *

self

)

This method is invoked when the render device has reset.

Parameters

self	The Renderer.

Remarks

Subclasses may override this method to allocate any OpenGL objects they require.

Definition at line 244 of file Renderer.c.

                                                 {
 
}

renderDeviceWillReset()

void renderDeviceWillReset

(

Renderer *

self

)

This method is invoked when the render device will become reset.

Parameters

self	The Renderer.

Remarks

Subclasses should override this method to free any OpenGL objects they own.

Definition at line 252 of file Renderer.c.

                                                  {
 
}

setClippingFrame()

void setClippingFrame	(	Renderer *	self,
		const SDL_Rect *	clippingFrame
	)

Sets the clipping frame for draw operations.

Primitives which fall outside of the clipping frame will not be visible.

Parameters

self	The Renderer.
clippingFrame	The clipping frame, or NULL to disable clipping.

Definition at line 260 of file Renderer.c.

                                                                            {
 
    SDL_Window *window = SDL_GL_GetCurrentWindow();
 
    SDL_Rect rect;
    if (clippingFrame) {
        rect = *clippingFrame;
    } else {
        rect = MakeRect(0, 0, 0, 0);
        SDL_GL_GetDrawableSize(window, &rect.w, &rect.h);
    }
 
    const SDL_Rect scissor = MVC_TransformToWindow(window, &rect);
 
    glScissor(scissor.x - 1, scissor.y - 1, scissor.w + 2, scissor.h + 2);
}

setDrawColor()

void setDrawColor	(	Renderer *	self,
		const SDL_Color *	color
	)

Sets the primary color for drawing operations.

Parameters

self	The Renderer.
color	The color.

Definition at line 281 of file Renderer.c.

                                                                 {
    glColor4ubv((const GLubyte *) color);
}

Field Documentation

interface

RendererInterface* Renderer::interface

protected

The interface.

Definition at line 61 of file Renderer.h.

object

Object Renderer::object

The superclass.

Definition at line 55 of file Renderer.h.

---

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

• Sources/ObjectivelyMVC/Renderer.h
• Sources/ObjectivelyMVC/Renderer.c