Interface to OpenGL. More...

#include <GlCommandSink.h>

Inheritance diagram for molecular::gfx::GlCommandSink:

Classes
class	IndexBuffer
	Buffer storing index data. More...

class	Program
	Compiled shader program. More...

class	RenderTarget
	Allows for rendering to textures. More...

class	Texture
	Texture object. More...

class	TransformFeedback

class	VertexBuffer
	Buffer storing vertex data. More...

Public Types
enum	BlendFactor { kOne = GL_ONE, kSrcAlpha = GL_SRC_ALPHA, kOneMinusSrcAlpha = GL_ONE_MINUS_SRC_ALPHA }

enum	CompareOp { kNever = GL_NEVER, kLess = GL_LESS, kEqual = GL_EQUAL, kLessOrEqual = GL_LEQUAL, kGreater = GL_GREATER, kNotEqual = GL_NOTEQUAL, kGreaterOrEqual = GL_GEQUAL, kAlways = GL_ALWAYS }

enum	CullMode { kFront = GL_FRONT, kBack = GL_BACK }

Public Member Functions
void	Init ()
	Initialise. More...

VertexBuffer *	CreateVertexBuffer ()

void	DestroyVertexBuffer (VertexBuffer *buffer)

IndexBuffer *	CreateIndexBuffer ()
	Create IndexBuffer. More...

void	DestroyIndexBuffer (IndexBuffer *buffer)

Texture *	CreateTexture ()

void	DestroyTexture (Texture *texture)

Program *	CreateProgram ()
	Create shader program. More...

void	DestroyProgram (Program *program)
	Destroy shader program. More...

void	UseProgram (Program *program)
	Make program current. More...

RenderTarget *	CreateRenderTarget ()

void	DestroyRenderTarget (RenderTarget *target)

void	SetTarget (RenderTarget *target)
	Set render target. More...

RenderTarget *	GetTarget ()

void	SetBaseTarget (const IntVector4 &viewport, int renderTarget)

TransformFeedback *	CreateTransformFeedback ()

void	DestroyTransformFeedback (TransformFeedback *feedback)

void	SetBackgroundColor (float r, float g, float b, float a=1.0f)

void	Clear (bool color=true, bool depth=true)
	Clear current render target. More...

void	Draw (IndexBuffer *buffer, const IndexBufferInfo &info)
	Draw indices. More...

void	Draw (TransformFeedback *transformFeedback, IndexBufferInfo::Mode mode)

void	Draw (IndexBufferInfo::Mode mode, unsigned int count)
	Draw vertices without indices. More...

void	ReadPixels (int x, int y, int width, int height, PixelFormat format, void *data)

void	SetBlending (bool enable, BlendFactor sourceFactor=kSrcAlpha, BlendFactor destFactor=kOneMinusSrcAlpha)

void	SetDepthState (bool depthTest, bool depthWrite, CompareOp compareOp=kLess)

void	SetScissor (bool enable, int x=0, int y=0, int width=0, int height=0)

void	SetRasterizationState (bool rasterizerDiscard, CullMode cullMode=kBack)

Static Public Member Functions
static void	CheckError (const char function, int line, const char file)

Static Public Attributes
static GlFunctions	gl

Detailed Description

Interface to OpenGL.

The constructor can be called outside the renderer thread. After construction, Init() must be called. Init() can only be called inside the renderer thread.

Member Enumeration Documentation

enum molecular::gfx::GlCommandSink::BlendFactor

Enumerator
kOne
kSrcAlpha
kOneMinusSrcAlpha

enum molecular::gfx::GlCommandSink::CompareOp

Enumerator
kNever
kLess
kEqual
kLessOrEqual
kGreater
kNotEqual
kGreaterOrEqual
kAlways

enum molecular::gfx::GlCommandSink::CullMode

Enumerator
kFront
kBack

Member Function Documentation

static void molecular::gfx::GlCommandSink::CheckError	(	const char *	function,
		int	line,
		const char *	file
	)

inlinestatic

void molecular::gfx::GlCommandSink::Clear	(	bool	color = `true`,
		bool	depth = `true`
	)

Clear current render target.

IndexBuffer* molecular::gfx::GlCommandSink::CreateIndexBuffer ( )

inline

Create IndexBuffer.

GlCommandSink::Program * molecular::gfx::GlCommandSink::CreateProgram ( )

Create shader program.

Call DestroyProgram after being finished with the program.

See also: DestroyProgram

Todo:: Return move-only type.

GlCommandSink::RenderTarget * molecular::gfx::GlCommandSink::CreateRenderTarget ( )

GlCommandSink::Texture * molecular::gfx::GlCommandSink::CreateTexture ( )

GlCommandSink::TransformFeedback * molecular::gfx::GlCommandSink::CreateTransformFeedback ( )

VertexBuffer* molecular::gfx::GlCommandSink::CreateVertexBuffer ( )

inline

void molecular::gfx::GlCommandSink::DestroyIndexBuffer ( IndexBuffer * buffer )

inline

void molecular::gfx::GlCommandSink::DestroyProgram ( Program * program )

Destroy shader program.

See also: CreateProgram

void molecular::gfx::GlCommandSink::DestroyRenderTarget ( RenderTarget * target )

void molecular::gfx::GlCommandSink::DestroyTexture ( Texture * texture )

void molecular::gfx::GlCommandSink::DestroyTransformFeedback ( TransformFeedback * feedback )

void molecular::gfx::GlCommandSink::DestroyVertexBuffer ( VertexBuffer * buffer )

inline

void molecular::gfx::GlCommandSink::Draw	(	IndexBuffer *	buffer,
		const IndexBufferInfo &	info
	)

Draw indices.

Requires an active program.

See also: UseProgram

void molecular::gfx::GlCommandSink::Draw	(	TransformFeedback *	transformFeedback,
		IndexBufferInfo::Mode	mode
	)

void molecular::gfx::GlCommandSink::Draw	(	IndexBufferInfo::Mode	mode,
		unsigned int	count
	)

Draw vertices without indices.

Requires active program.

RenderTarget* molecular::gfx::GlCommandSink::GetTarget ( )

inline

void molecular::gfx::GlCommandSink::Init ( )

Initialise.

This must be called in the renderer thread.

void molecular::gfx::GlCommandSink::ReadPixels	(	int	x,
		int	y,
		int	width,
		int	height,
		PixelFormat	format,
		void *	data
	)

void molecular::gfx::GlCommandSink::SetBackgroundColor	(	float	r,
		float	g,
		float	b,
		float	a = `1.0f`
	)

inline

void molecular::gfx::GlCommandSink::SetBaseTarget	(	const IntVector4 &	viewport,
		int	renderTarget
	)

Registers the currently bound framebuffer as the base target. In the simplest case this will be 0, which is the screen.

void molecular::gfx::GlCommandSink::SetBlending	(	bool	enable,
		BlendFactor	sourceFactor = `kSrcAlpha`,
		BlendFactor	destFactor = `kOneMinusSrcAlpha`
	)

void molecular::gfx::GlCommandSink::SetDepthState	(	bool	depthTest,
		bool	depthWrite,
		CompareOp	compareOp = `kLess`
	)

void molecular::gfx::GlCommandSink::SetRasterizationState	(	bool	rasterizerDiscard,
		CullMode	cullMode = `kBack`
	)

void molecular::gfx::GlCommandSink::SetScissor	(	bool	enable,
		int	x = `0`,
		int	y = `0`,
		int	width = `0`,
		int	height = `0`
	)

void molecular::gfx::GlCommandSink::SetTarget ( RenderTarget * target )

Set render target.

Pass nullptr to render to the base target. The base target can be specified with SetBaseTarget.

void molecular::gfx::GlCommandSink::UseProgram ( Program * program )

Make program current.

Also call before setting uniforms.

Member Data Documentation

GlFunctions molecular::gfx::GlCommandSink::gl

static

Todo:: Private? Global? Singleton? Thread local?

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

/home/travis/build/cmdrf/molecular/molecular-gfx/molecular/gfx/opengl/GlCommandSink.h
/home/travis/build/cmdrf/molecular/molecular-gfx/molecular/gfx/opengl/GlCommandSink.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation