Namespaces

Context /

#include “cinder/gl/Context.h”

Typedefs:

ContextRef

Classes:

PlatformData

Public Member Functions

~Context ()
const std::shared_ptr< PlatformData >

getPlatformData () const

Returns the platform-specific OpenGL Context . CGLContextObj on Mac OS X, EAGLContext on iOS.
void

makeCurrent (bool force=false) const

Makes this the currently active OpenGL Context . If force then the cached pointer to the current Context is ignored.
std::vector< mat4 > &

getModelMatrixStack ()

Returns a reference to the stack of Model matrices.
const std::vector< mat4 > &

getModelMatrixStack () const

Returns a const reference to the stack of Model matrices.
std::vector< mat4 > &

getViewMatrixStack ()

Returns a reference to the stack of View matrices.
const std::vector< mat4 > &

getViewMatrixStack () const

Returns a const reference to the stack of Model matrices.
std::vector< mat4 > &

getProjectionMatrixStack ()

Returns a reference to the stack of Projection matrices.
const std::vector< mat4 > &

getProjectionMatrixStack () const

Returns a const reference to the stack of Projection matrices.
void

bindVao (Vao *vao)

Binds a VAO. Consider using a ScopedVao instead.
void

bindVao (VaoRef &vao)

Binds a VAO. Consider using a ScopedVao instead.
void

pushVao (Vao *vao)

Pushes and binds the VAO vao .
void

pushVao (const VaoRef &vao)

Pushes and binds the VAO vao .
void

pushVao ()

Duplicates and pushes the current VAO binding.
void

popVao ()

Pops the current VAO binding.
Vao *

getVao ()

Returns the currently bound VAO.
void

restoreInvalidatedVao ()

Restores the VAO binding when code that is not caching aware has invalidated it. Not typically necessary.
void

vaoCreated (const Vao *vao)

Used by object tracking.
void

vaoDeleted (const Vao *vao)

Used by object tracking.
void

viewport (const std::pair< ivec2, ivec2 > &viewport)

Analogous to glViewport(). Sets the viewport based on a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively.
void

pushViewport (const std::pair< ivec2, ivec2 > &viewport)

Pushes the viewport based on a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively.
void

pushViewport ()

Duplicates and pushes the top of the Viewport stack.
void

popViewport (bool forceRestore=false)

Pops the viewport. If forceRestore then redundancy checks are skipped and the hardware state is always set.
std::pair< ivec2, ivec2 >

getViewport ()

Returns a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively of the viewport.
void

setScissor (const std::pair< ivec2, ivec2 > &scissor)

Sets the scissor box based on a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively.
void

pushScissor (const std::pair< ivec2, ivec2 > &scissor)

Pushes the scissor box based on a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively.
void

pushScissor ()

Duplicates and pushes the top of the Scissor box stack.
void

popScissor (bool forceRestore=false)

Pushes the scissor box based on a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively. If forceRestore then redundancy checks are skipped and the hardware state is always set.
std::pair< ivec2, ivec2 >

getScissor ()

Returns a pair<ivec2,ivec2> representing the position of the lower-left corner and the size, respectively of the scissor box.
void

cullFace (GLenum face)

Analogous to glCullFace( face ). Valid arguments are GL_FRONT and GL_BACK .
void

pushCullFace (GLenum face)

Pushes the cull face face . Valid arguments are GL_FRONT and GL_BACK .
void

pushCullFace ()

Duplicates and pushes the top of the Cull Face stack.
void

popCullFace (bool forceRestore=false)

Pops the top of the Cull Face stack. If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLenum

getCullFace ()

Returns a GLenum representing the current cull face. Either GL_FRONT or GL_BACK .
void

frontFace (GLenum mode)

Set the winding order defining front-facing polygons. Valid arguments are GL_CW and GL_CCW . Default is GL_CCW .
void

pushFrontFace (GLenum mode)

Push the winding order defining front-facing polygons. Valid arguments are GL_CW and GL_CCW . Default is GL_CCW .
void

pushFrontFace ()

Push the winding order defining front-facing polygons.
void

popFrontFace (bool forceRestore=false)

Pops the winding order defining front-facing polygons. If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLenum

getFrontFace ()

Returns the winding order defining front-facing polygons, either GL_CW or GL_CCW (the default).
void

logicOp (GLenum mode)

Analogous to glLogicOp( mode ). Valid arguments are GL_CLEAR , GL_SET , GL_COPY , GL_COPY_INVERTED , GL_NOOP , GL_INVERT , GL_AND , GL_NAND , GL_OR , GL_NOR , GL_XOR , GL_EQUIV , GL_AND_REVERSE , GL_AND_INVERTED , GL_OR_REVERSE , or GL_OR_INVERTED .
void

pushLogicOp (GLenum mode)

Pushes the logical operation mode . Valid arguments are GL_CLEAR , GL_SET , GL_COPY , GL_COPY_INVERTED , GL_NOOP , GL_INVERT , GL_AND , GL_NAND , GL_OR , GL_NOR , GL_XOR , GL_EQUIV , GL_AND_REVERSE , GL_AND_INVERTED , GL_OR_REVERSE , or GL_OR_INVERTED .
void

popLogicOp (bool forceRestore=false)

Pops the top of the Logic Op stack. If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLenum

getLogicOp ()

Returns a GLenum representing the current logical operation.
void

bindBuffer (GLenum target, GLuint id)

Analogous to glBindBuffer( target , id )
void

pushBufferBinding (GLenum target, GLuint id)

Pushes and binds buffer object id for the target target .
void

pushBufferBinding (GLenum target)

Duplicates and pushes the buffer binding for the target target .
void

popBufferBinding (GLenum target)

Pops the buffer binding for the target target .
GLuint

getBufferBinding (GLenum target)

Returns the current object binding for target . If not cached, queries the GL for the current value (and caches it).
void

reflectBufferBinding (GLenum target, GLuint id)

Updates the binding stack without rebinding. Not generally necessary to call directly.
void

bufferCreated (const BufferObj *buffer)

Used by object tracking.
void

bufferDeleted (const BufferObj *buffer)

No-op if BufferObj wasn't bound, otherwise reflects the binding as 0 (in accordance with what GL has done automatically). Also used by object tracking.
void

invalidateBufferBindingCache (GLenum target)

Marks the cache of target's buffer binding as invalid. Typically called when a VAO is unbound, against GL_ELEMENT_ARRAY_BUFFER.
void

restoreInvalidatedBufferBinding (GLenum target)

Restores a buffer binding when code that is not caching aware has invalidated it. Not typically necessary.
void

bindRenderbuffer (GLenum target, GLuint id)

Analogous to glBindRenderbuffer( target , id )
void

pushRenderbufferBinding (GLenum target, GLuint id)

Pushes and binds renderbuffer object id for the target target .
void

pushRenderbufferBinding (GLenum target)

Duplicates and pushes the renderbuffer binding for the target target .
void

popRenderbufferBinding (GLenum target)

Pops the renderbuffer binding for the target target .
GLuint

getRenderbufferBinding (GLenum target)

Returns the current renderbuffer binding for target . If not cached, queries the GL for the current value (and caches it).
void

renderbufferDeleted (const Renderbuffer *buffer)

No-op if Renderbuffer wasn't bound, otherwise reflects the binding as 0 (in accordance with what GL has done automatically).
void

bindGlslProg (const GlslProg *prog)

Binds GLSL program prog . Analogous to glUseProgram()
void

bindGlslProg (GlslProgRef &prog)
void

pushGlslProg (const GlslProg *prog)

Pushes and binds GLSL program prog .
void

pushGlslProg (GlslProgRef &prog)
void

pushGlslProg ()

Duplicates and pushes the top of the GlslProg stack.
void

popGlslProg (bool forceRestore=false)

Pops the GlslProg stack. If forceRestore then redundancy checks are skipped and the hardware state is always set.
const GlslProg *

getGlslProg ()

Returns the currently bound GlslProg .
void

glslProgCreated (const GlslProg *glslProg)

Used by object tracking.
void

glslProgDeleted (const GlslProg *glslProg)

Used by object tracking.
void

bindBufferBase (GLenum target, GLuint index, const BufferObjRef &buffer)

Binds ref to the specific index within target . Analogous to glBindBufferBase()
void

bindBufferBase (GLenum target, GLuint index, GLuint id)

Binds ref to the specific index within target . Analogous to glBindBufferBase()
void

bindBufferRange (GLenum target, GLuint index, const BufferObjRef &buffer, GLintptr offset, GLsizeiptr size)

Analogous to glBindBufferRange()
void

bindTexture (GLenum target, GLuint textureId)

Analogous to glBindTexture( target , textureId ) for the active texture unit.
void

bindTexture (GLenum target, GLuint textureId, uint8_t textureUnit)

Analogous to glBindTexture( target , textureId ) for texture unit textureUnit .
void

pushTextureBinding (GLenum target, uint8_t textureUnit)

Duplicates and pushes the binding for the target target for texture unit textureUnit .
void

pushTextureBinding (GLenum target, GLuint textureId, uint8_t textureUnit)

Pushes and binds textureId for the target target for texture unit textureUnit .
void

popTextureBinding (GLenum target, uint8_t textureUnit, bool forceRestore=false)

Pops the texture binding for the target target for texture unit textureUnit . If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLuint

getTextureBinding (GLenum target)

Returns the current texture binding for target for the active texture unit. If not cached, queries the GL for the current value (and caches it).
GLuint

getTextureBinding (GLenum target, uint8_t textureUnit)

Returns the current texture binding for target for texture unit textureUnit . If not cached, queries the GL for the current value (and caches it).
void

textureCreated (const TextureBase *texture)

Used by object tracking.
void

textureDeleted (const TextureBase *texture)

No-op if texture wasn't bound, otherwise reflects the texture unit's binding as 0 (in accordance with what GL has done automatically). Also used by object tracking.
void

setActiveTexture (uint8_t textureUnit)

Sets the active texture unit; expects values relative to 0 , not GL_TEXTURE0.
void

pushActiveTexture (uint8_t textureUnit)

Pushes and sets the active texture unit; expects values relative to 0 , not GL_TEXTURE0.
void

pushActiveTexture ()

Duplicates and pushes the active texture unit.
void

popActiveTexture (bool forceRestore=false)

Sets the active texture unit; expects values relative to 0 , not GL_TEXTURE0. If forceRestore then redundancy checks are skipped and the hardware state is always set.

Sets the active texture unit; expects values relative to 0 , not GL_TEXTURE0.
uint8_t

getActiveTexture ()

Returns the active texture unit with values relative to 0 , not GL_TEXTURE0.
void

bindFramebuffer (const FboRef &fbo, GLenum target=GL_FRAMEBUFFER)

Analogous to glBindFramebuffer()
void

bindFramebuffer (GLenum target, GLuint framebuffer)

Analogous to glBindFramebuffer(). Prefer the FboRef variant when possible. This does not allow gl::Fbo to mark itself as needing multisample resolution.
void

pushFramebuffer (const FboRef &fbo, GLenum target=GL_FRAMEBUFFER)

Pushes and sets the active framebuffer.
void

pushFramebuffer (GLenum target, GLuint framebuffer=GL_FRAMEBUFFER)

Pushes and sets the active framebuffer. Prefer the FboRef variant when possible. This does not allow gl::Fbo to mark itself as needing multisample resolution.
void

pushFramebuffer (GLenum target=GL_FRAMEBUFFER)

Duplicates and pushes the active framebuffer.
void

popFramebuffer (GLuint framebuffer=GL_FRAMEBUFFER)

Pops the active framebuffer.
void

unbindFramebuffer ()

Unbinds the current FBO (binding the default (screen) framebuffer)
GLuint

getFramebuffer (GLenum target=GL_FRAMEBUFFER)

Returns the ID of the framebuffer currently bound to target .
void

framebufferCreated (const Fbo *fbo)

Used by object tracking.
void

framebufferDeleted (const Fbo *fbo)

Used by object tracking.
void

setBoolState (GLenum cap, GLboolean value)

Analogous to glEnable() or glDisable(). Enables or disables OpenGL capability cap .
void

pushBoolState (GLenum cap, GLboolean value)

Pushes and sets the state stack for OpenGL capability cap to value .
void

pushBoolState (GLenum cap)

Duplicates and pushes the state stack for OpenGL capability cap .
void

popBoolState (GLenum cap, bool forceRestore=false)

Pops the state stack for OpenGL capability cap . If forceRestore then redundancy checks are skipped and the hardware state is always set.
void

enable (GLenum cap, GLboolean value=true)

Synonym for setBoolState() . Enables or disables OpenGL capability cap .
GLboolean

getBoolState (GLenum cap)

Analogous to glIsEnabled(). Returns whether a given OpenGL capability is enabled or not.
void

setBoolState (GLenum cap, GLboolean value, const std::function< void(GLboolean)> &setter)

Enables or disables OpenGL capability cap . Calls setter rather than glEnable or glDisable. Not generally necessary to call directly.
void

blendFunc (GLenum sfactor, GLenum dfactor)

Analogous glBlendFunc(). Consider using a ScopedBlend instead.
void

blendFuncSeparate (GLenum srcRGB, GLenum dstRGB, GLenum srcAlpha, GLenum dstAlpha)

Analogous to glBlendFuncSeparate(). Consider using a ScopedBlend instead.
void

pushBlendFuncSeparate (GLenum srcRGB, GLenum dstRGB, GLenum srcAlpha, GLenum dstAlpha)

Analogous to glBlendFuncSeparate, but pushes values rather than replaces them.
void

pushBlendFuncSeparate ()

Duplicates and pushes the glBlendFunc state stack.
void

popBlendFuncSeparate (bool forceRestore=false)

Pops the current blend functions. If forceRestore then redundancy checks are skipped and the hardware state is always set.
void

getBlendFuncSeparate (GLenum *resultSrcRGB, GLenum *resultDstRGB, GLenum *resultSrcAlpha, GLenum *resultDstAlpha)

Returns the current values for glBendFuncs.
void

lineWidth (float lineWidth)

Sets the current line width.
void

pushLineWidth (float lineWidth)

Pushes and sets the current line width.
void

pushLineWidth ()

Duplicates and pushes the current line width.
void

popLineWidth (bool forceRestore=false)

Sets the current line width. If forceRestore then redundancy checks are skipped and the hardware state is always set.
float

getLineWidth ()

Returns the current line width.
void

depthMask (GLboolean enable)

Analogous to glDepthMask(). Enables or disables writing into the depth buffer.
void

pushDepthMask (GLboolean enable)

Push the depth buffer writing flag.
void

pushDepthMask ()

Push the depth buffer writing flag.
void

popDepthMask (bool forceRestore=false)

Pops the depth buffer writing flag. If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLboolean

getDepthMask ()

Returns the depth buffer writing flag.
void

depthFunc (GLenum func)

Set the depth buffer comparison function. Analogous to glDepthFunc(). Valid arguments are GL_NEVER , GL_LESS , GL_EQUAL , GL_LEQUAL , GL_GREATER , GL_NOTEQUAL , GL_GEQUAL and GL_ALWAYS . Default is GL_LESS .
void

pushDepthFunc (GLenum func)

Push the depth buffer comparison function. Valid arguments are GL_NEVER , GL_LESS , GL_EQUAL , GL_LEQUAL , GL_GREATER , GL_NOTEQUAL , GL_GEQUAL and GL_ALWAYS . Default is GL_LESS .
void

pushDepthFunc ()

Push the depth buffer comparison function.
void

popDepthFunc (bool forceRestore=false)

Pops the depth buffer comparison function. If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLenum

getDepthFunc ()

Returns the depth buffer comparison function, either GL_NEVER , GL_LESS , GL_EQUAL , GL_LEQUAL , GL_GREATER , GL_NOTEQUAL , GL_GEQUAL or GL_ALWAYS .
void

polygonMode (GLenum face, GLenum mode)

Sets the current polygon rasterization mode. face must be GL_FRONT_AND_BACK . GL_POINT , GL_LINE & GL_FILL are legal values for mode .
void

pushPolygonMode (GLenum face, GLenum mode)

Pushes the current polygon rasterization mode. face must be GL_FRONT_AND_BACK . GL_POINT , GL_LINE & GL_FILL are legal values for mode .
void

pushPolygonMode (GLenum face)

Pushes the current polygon rasterization mode. face must be GL_FRONT_AND_BACK .
void

popPolygonMode (GLenum face, bool forceRestore=false)

Pops the current polygon rasterization mode. face must be GL_FRONT_AND_BACK . If forceRestore then redundancy checks are skipped and the hardware state is always set.
GLenum

getPolygonMode (GLenum face)

Returns the current polygon rasterization mode. face must be GL_FRONT_AND_BACK .
void

sanityCheck ()
void

printState (std::ostream &os) const
const std::set< const TextureBase * > &

getLiveTextures () const

Returns the container of live Textures. Requires object tracking to be enabled.
const std::set< const BufferObj * > &

getLiveBuffers () const

Returns the container of live BufferObjs. Requires object tracking to be enabled.
const std::set< const GlslProg * > &

getLiveGlslProgs () const

Returns the container of live GlslProgs. Requires object tracking to be enabled.
const std::set< const Vao * > &

getLiveVaos () const

Returns the container of live Vaos. Requires object tracking to be enabled.
const std::set< const Fbo * > &

getLiveFbos () const

Returns the container of live Fbos. Requires object tracking to be enabled.
void

enableVertexAttribArray (GLuint index)

Analogous to glEnableVertexAttribArray()
void

disableVertexAttribArray (GLuint index)

Analogous to glDisableVertexAttribArray()
void

vertexAttribPointer (GLuint index, GLint size, GLenum type, GLboolean normalized, GLsizei stride, const GLvoid *pointer)

Analogous to glVertexAttribPointer()
void

vertexAttribIPointer (GLuint index, GLint size, GLenum type, GLsizei stride, const GLvoid *pointer)

Analogous to glVertexAttribIPointer()
void

vertexAttribDivisor (GLuint index, GLuint divisor)

Analogous to glVertexAttribDivisor()
void

vertexAttrib1f (GLuint index, float v0)

Analogous to glVertexAttrib1f()
void

vertexAttrib2f (GLuint index, float v0, float v1)

Analogous to glVertexAttrib2f()
void

vertexAttrib3f (GLuint index, float v0, float v1, float v2)

Analogous to glVertexAttrib3f()
void

vertexAttrib4f (GLuint index, float v0, float v1, float v2, float v3)

Analogous to glVertexAttrib4f()
void

drawArrays (GLenum mode, GLint first, GLsizei count)

Analogous to glDrawArrays()
void

drawElements (GLenum mode, GLsizei count, GLenum type, const GLvoid *indices)

Analogous to glDrawElements()
const ColorAf &

getCurrentColor () const

Returns the current active color, used in immediate-mode emulation and as UNIFORM_COLOR.
void

setCurrentColor (const ColorAf &color)
GlslProgRef &

getStockShader (const ShaderDef &shaderDef)
void

setDefaultShaderVars ()
VboRef

getDefaultArrayVbo (size_t requiredSize=0)

Returns default VBO for vertex array data, ensuring it is at least requiredSize bytes. Designed for use with convenience functions.
VboRef

getDefaultElementVbo (size_t requiredSize=0)

Returns default VBO for element array data, ensuring it is at least requiredSize bytes. Designed for use with convenience functions.
Vao *

getDefaultVao ()

Returns default VAO, designed for use with convenience functions.
VboRef

getDrawTextureVbo ()

Returns a VBO for drawing textured rectangles; used by gl::draw(TextureRef)
Vao *

getDrawTextureVao ()

Returns a VBO for drawing textured rectangles; used by gl::draw(TextureRef)
VertBatch &

immediate ()

Returns a reference to the immediate mode emulation structure. Generally use gl::begin() and friends instead.

Static Public Member Functions

ContextRef

create (const Context *sharedContext)

Creates a new OpenGL context, sharing resources and pixel format with sharedContext. This (essentially) must be done from the primary thread on MSW. ANGLE doesn't support multithreaded use. Destroys the platform Context on destruction.
ContextRef

createFromExisting (const std::shared_ptr< PlatformData > &platformData)

Creates based on an existing platform-specific GL context. platformContext is CGLContextObj on Mac OS X, EAGLContext on iOS, HGLRC on MSW. platformContext is an HDC on MSW and ignored elsewhere. Does not assume ownership of the platform's context.
Context *

getCurrent ()

Returns the thread's currently active OpenGL Context .
void

reflectCurrent (Context *context)

Set thread's local storage to reflect context as the active Context .

Protected Member Functions

bool

pushStackState (std::vector< T > &stack, T value)

Returns true if value is different from the previous top of the stack.
bool

popStackState (std::vector< T > &stack)

Returns true if the new top of stack is different from the previous top, or the stack is empty.
bool

setStackState (std::vector< T > &stack, T value)

Returns true if value is different from the previous top of the stack.
bool

getStackState (std::vector< T > &stack, T *result)

Returns true if result is valid; will return false when stack was empty.
void

allocateDefaultVboAndVao ()

Protected Attributes

std::map< ShaderDef, GlslProgRef >

mStockShaders
std::map< GLenum, std::vector< int > >

mBufferBindingStack
std::map< GLenum, std::vector< int > >

mRenderbufferBindingStack
std::vector< const GlslProg * >

mGlslProgStack
std::vector< Vao * >

mVaoStack
std::vector< GLint >

mBlendSrcRgbStack
std::vector< GLint >

mBlendDstRgbStack
std::vector< GLint >

mBlendSrcAlphaStack
std::vector< GLint >

mBlendDstAlphaStack
std::vector< GLint >

mFramebufferStack
std::vector< GLenum >

mCullFaceStack
std::vector< GLenum >

mFrontFaceStack
std::vector< GLenum >

mLogicOpStack
std::vector< GLenum >

mPolygonModeStack
std::vector< GLboolean >

mDepthMaskStack
std::vector< GLenum >

mDepthFuncStack
std::map< GLenum, std::vector< GLboolean > >

mBoolStateStack
std::map< uint8_t, std::map< GLenum, std::vector< GLint > > >

mTextureBindingStack
std::vector< uint8_t >

mActiveTextureStack
VaoRef

mDefaultVao
VboRef

mDefaultArrayVbo [4]
VboRef

mDefaultElementVbo
uint8_t

mDefaultArrayVboIdx
VertBatchRef

mImmediateMode
VaoRef

mDrawTextureVao
VboRef

mDrawTextureVbo

Friends

friend class

Environment
friend class

Texture2d

Namespaces

Classes

Modules

Guides

Reference

Context /

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends