oglplus::Context Class Reference

Wrapper for the current OpenGL context operations. More...

#include </home/chochlik/devel/oglplus/include/oglplus/context.hpp>

Inheritance diagram for oglplus::Context:

Collaboration diagram for oglplus::Context:

List of all members.

Public Types
typedef OneOf< GLenum, std::tuple < oglplus::ColorBuffer, oglplus::FramebufferColorAttachment > >	ColorBuffer
	Color buffer specification type.
Static Public Member Functions
static ErrorCode	GetError (void)
	returns the error code
static void	Enable (Capability capability)
	Enable a capability.
static void	Enable (Functionality functionality, GLuint offset)
	Enable a functionality.
static void	Enable (Capability capability, GLuint index)
	Enable a capability for an indexed target.
static void	Disable (Capability capability)
	Disable a capability.
static void	Disable (Functionality functionality, GLuint offset)
	Disable a functionality.
static void	Disable (Capability capability, GLuint index)
	Disable a capability for an indexed target.
static bool	IsEnabled (Capability capability)
	Checks if a capability is enabled.
static bool	IsEnabled (Functionality functionality, GLuint offset)
	Checks if a functionality is enabled.
static bool	IsEnabled (Capability capability, GLuint index)
	Check if a capability is enabled for indexed target.
static void	Viewport (GLint x, GLint y, GLsizei w, GLsizei h)
	Sets the extents of the current viewport.
static void	Viewport (GLsizei w, GLsizei h)
	Sets the size of the current viewport starting at (0,0)
static void	Viewport (GLuint viewport, GLfloat x, GLfloat y, GLfloat width, GLfloat height)
	Sets the extents of the specified viewport.
static void	Viewport (GLuint viewport, const GLfloat *extents)
	Sets the extents of the specified viewport.
static ViewportExtents	Viewport (GLuint viewport)
	Returns the extents of the specified viewport.
static ViewportPosition	ViewportBoundsRange (void)
	Returns the implementation-dependent viewport bounds range.
static ViewportSize	MaxViewportDims (void)
	Returns the implementation-dependent maximum viewport dimensions.
static void	DepthRange (GLclampf near_val, GLclampf far_val)
	Sets the near_val / far_val depth range of the default viewport.
static void	DepthRange (GLclampd near_val, GLclampd far_val)
	Sets the near_val / far_val depth range of the default viewport.
static void	DepthRange (GLuint viewport, GLclampd near_val, GLclampd far_val)
	Sets the near_val / far_val depth range of a viewport.
static oglplus::context::DepthRange	DepthRange (GLuint viewport)
	Returns the depth range of the specified viewport.
static GLuint	MaxViewports (void)
	Returns the number of available viewports.
static void	ViewportArray (GLuint first, GLsizei count, const GLfloat *extents)
	Sets extents of the viewports specified by first and count.
static void	DepthRangeArray (GLuint first, GLsizei count, const GLclampd *v)
	Sets depth ranges of viewports specified by first and count.
static void	DrawBuffer (ColorBuffer buffer)
	Sets the destination color buffer for draw operations.
template<unsigned N>
static void	DrawBuffers (ColorBuffer(&buffers)[N])
	Sets the destination color buffers for draw operations.
static void	ReadBuffer (ColorBuffer buffer)
	Sets the source color buffer for read operations.
static void	ColorMask (bool r, bool g, bool b, bool a)
	Sets the color mask.
static void	ColorMask (GLuint buffer, bool r, bool g, bool b, bool a)
	Sets the color mask for a particular buffer.
static void	DepthMask (bool mask)
	Sets the depth mask.
static void	StencilMask (GLuint mask)
	Sets the stencil mask.
static void	StencilMaskSeparate (Face face, GLuint mask)
	Sets the stencil mask separately for front and back faces.
static oglplus::context::RGBAMask	ColorWriteMask (GLuint buffer=0)
	Returns the value of color buffer write mask.
static bool	DepthWriteMask (void)
	Returns the value of depth buffer write mask.
static GLuint	StencilWriteMask (bool backface=false)
	Returns the value of stencil write mask.
static void	ClearColor (GLclampf r, GLclampf g, GLclampf b, GLclampf a)
	Sets the clear color.
static void	ClearDepth (GLclampd d)
	Sets the clear depth.
static void	ClearStencil (GLint s)
	Sets the clear stencil buffer value.
static ClrBits	Clear (void)
	Clears buffers specified by calling functions of the returned object.
static void	Clear (Bitfield< oglplus::ClearBit > bits)
	Clears buffers specified by the bits parameter.
static oglplus::context::RGBAValue	ColorClearValue (void)
	Returns the color value used for clearing of the color buffer.
static GLfloat	DepthClearValue (void)
	Returns the depth value used for clearing of the depth buffer.
static GLint	ClearStencilValue (void)
	Returns the value used for clearing of the stencil buffer.
static void	FrontFace (FaceOrientation orientation)
	Sets the polygon facing mode.
static void	CullFace (Face mode)
	Sets the face culling mode.
static Face	CullFaceMode (void)
	Returns the face culling mode.
static void	PolygonMode (Face face, oglplus::PolygonMode mode)
	Sets the polygon rasterization mode.
static void	PolygonMode (oglplus::PolygonMode mode)
	Sets the polygon rasterization mode.
static void	PolygonOffset (GLfloat factor, GLfloat units)
	Sets the polygon depth offset.
static GLfloat	PolygonOffsetFactor (void)
	Returns the polygon offset factor.
static GLfloat	PolygonOffsetUnits (void)
	Returns the polygon offset units.
static void	LineWidth (GLfloat width)
	Sets the line width.
static GLfloat	LineWidth (void)
	Returns the line width.
static void	PointSize (GLfloat size)
	Sets the point size.
static GLfloat	PointSize (void)
	Returns the point size.
static void	PointFadeThresholdSize (GLfloat size)
	Sets the point fade threshold size.
static GLfloat	PointFadeThresholdSize (void)
	Returns the point fade threshold size.
static void	ProvokingVertex (ProvokeMode mode)
	Sets the provoking vertex selection mode for flatshading.
static ProvokeMode	ProvokingVertex (void)
	Returns the provoking vertex selection mode for flatshading.
static void	DrawArrays (PrimitiveType primitive, GLint first, GLsizei count)
	Draws count of primitives from the bound array buffers.
static void	DrawArraysInstancedBaseInstance (PrimitiveType primitive, GLint first, GLsizei count, GLsizei inst_count, GLsizei base_instance)
	Draws count of primitives from the bound array buffers.
static void	DrawArraysInstanced (PrimitiveType primitive, GLint first, GLsizei count, GLsizei inst_count)
	Draws count of primitives from the bound array buffers.
static void	DrawArraysIndirect (PrimitiveType primitive, const void *indirect=nullptr)
	Draws primitives from an indirect buffer.
static void	MultiDrawArrays (PrimitiveType primitive, const GLint *first, const GLsizei *count, GLsizei primcount)
	Draws primcount ranges of primitives from the bound array buffers.
static void	MultiDrawArraysIndirect (PrimitiveType primitive, GLsizei draw_count, GLsizei stride=0, const void *indirect=nullptr)
	Draws multiple sets of primitives from an indirect buffer.
static void	DrawElements (PrimitiveType primitive, GLsizei count, DataType data_type)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElements (PrimitiveType primitive, GLsizei count, const T *indices)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawElementsInstanced (PrimitiveType primitive, GLsizei count, DataType data_type, GLsizei instance_count)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElementsInstanced (PrimitiveType primitive, GLsizei count, const T *indices, GLsizei instance_count)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawElementsInstancedBaseInstance (PrimitiveType primitive, GLsizei count, DataType data_type, GLsizei inst_count, GLuint base_instance)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElementsInstancedBaseInstance (PrimitiveType primitive, GLsizei count, const T *indices, GLsizei inst_count, GLuint base_instance)
	Draws a sequence of primitives from the bound element array buffers.
static void	MultiDrawElements (PrimitiveType primitive, const GLsizei *count, DataType data_type, GLsizei draw_count)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	MultiDrawElements (PrimitiveType primitive, const GLsizei *count, T *const *indices, GLsizei draw_count)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawRangeElements (PrimitiveType primitive, GLuint start, GLuint end, GLsizei count, DataType data_type)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawRangeElements (PrimitiveType primitive, GLuint start, GLuint end, GLsizei count, const T *indices)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawElementsIndirect (PrimitiveType primitive, DataType data_type, const void *indirect=nullptr)
	Draws a sequence of primitives from the bound element array buffers.
static void	MultiDrawElementsIndirect (PrimitiveType primitive, DataType data_type, GLsizei draw_count, GLsizei stride=0, const void *indirect=nullptr)
	Draws sequences of primitives from the bound element array buffers.
static void	DrawElementsBaseVertex (PrimitiveType primitive, GLsizei count, DataType data_type, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElementsBaseVertex (PrimitiveType primitive, GLsizei count, const T *indices, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawRangeElementsBaseVertex (PrimitiveType primitive, GLuint start, GLuint end, GLsizei count, DataType data_type, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawRangeElementsBaseVertex (PrimitiveType primitive, GLuint start, GLuint end, GLsizei count, const T *indices, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawElementsInstancedBaseVertex (PrimitiveType primitive, GLsizei count, DataType data_type, GLsizei inst_count, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElementsInstancedBaseVertex (PrimitiveType primitive, GLsizei count, const T *indices, GLsizei inst_count, GLint base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
static void	MultiDrawElementsBaseVertex (PrimitiveType primitive, const GLsizei *count, DataType data_type, GLsizei draw_count, const GLint *base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	MultiDrawElementsBaseVertex (PrimitiveType primitive, const GLsizei *count, T *const *indices, GLsizei draw_count, const GLint *base_vertex)
	Draws a sequence of primitives from the bound element array buffers.
static void	DrawElementsInstancedBaseVertexBaseInstance (PrimitiveType primitive, GLsizei count, DataType data_type, GLsizei inst_count, GLint base_vertex, GLuint base_instance)
	Draws a sequence of primitives from the bound element array buffers.
template<typename T >
static std::enable_if < IsGLDataType< T >::value, void >::type	DrawElementsInstancedBaseVertexBaseInstance (PrimitiveType primitive, GLsizei count, const T *indices, GLsizei inst_count, GLint base_vertex, GLuint base_instance)
	Draws a sequence of primitives from the bound element array buffers.
static void	PrimitiveRestartIndex (GLuint index)
	Sets the primitive restart index.
static void	DispatchCompute (GLuint num_groups_x, GLuint num_groups_y, GLuint num_groups_z)
	Launches several work groups.
static void	DispatchComputeIndirect (GLintptr indirect)
	Launches indirectly several work groups.
static void	DepthFunc (CompareFunction function)
	Sets the depth comparison function.
static CompareFunction	DepthFunc (void)
	Returns the depth comparison function.
static void	StencilFunc (CompareFunction func, GLint ref=GLint(0), GLuint mask=~GLuint(0))
	Sets the stencil function.
static CompareFunction	StencilFunc (bool backface=false)
	Returns the stencil function.
static void	StencilFuncSeparate (Face face, CompareFunction func, GLint ref=GLint(0), GLuint mask=~GLuint(0))
	Sets the stencil function separately for front and back faces.
static void	StencilOp (StencilOperation sfail, StencilOperation dfail, StencilOperation dpass)
	Sets the stencil operation.
static void	StencilOpSeparate (Face face, StencilOperation sfail, StencilOperation dfail, StencilOperation dpass)
	Sets the stencil operation separately for front and back faces.
static GLuint	StencilValueMask (bool backface=false)
	Returns the value of stencil mask.
static GLuint	StencilRef (bool backface=false)
	Returns the stencil reference value.
static StencilOperation	StencilFail (bool backface=false)
	Returns the stencil-fail action.
static StencilOperation	StencilPassDepthFail (bool backface=false)
	Returns the stencil-pass depth-fail action.
static StencilOperation	StencilPassDepthPass (bool backface=false)
	Returns the stencil-pass depth-pass action.
static void	Scissor (GLint left, GLint bottom, GLsizei width, GLsizei height)
	Defines the scissor rectangle for the first viewport.
static void	Scissor (GLuint viewport, GLint left, GLint bottom, GLsizei width, GLsizei height)
	Defines the scissor rectangle for the specified viewport.
static void	Scissor (GLuint viewport, GLint *v)
	Defines the scissor rectangle for the specified viewport.
static void	ScissorArray (GLuint first, GLsizei count, GLint *v)
	Defines scissor boxes for viewports specified by first count.
static ScissorRectangle	ScissorBox (GLuint viewport)
	Returns the extents of scissor box of the specified viewport.
static void	LogicOp (ColorLogicOperation op)
	Sets the color logical operation.
static ColorLogicOperation	LogicOpMode (void)
	Returns the color logical operation.
static void	PixelStore (PixelStorageMode parameter, GLfloat value)
	Sets the value of a pixel storage parameter.
static void	PixelStore (PixelStorageMode parameter, GLint value)
	Sets the value of a pixel storage parameter.
static void	ReadPixels (GLint x, GLint y, GLsizei width, GLsizei height, PixelDataFormat format, PixelDataType type, void *data)
	Sets the value of a pixel storage parameter.
static void	BlitFramebuffer (GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1, GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1, Bitfield< oglplus::BufferSelectBit > mask, BlitFilter filter)
	Transfers a rectangle of pixels from the read buffer the draw buffer.
static void	BlendEquation (oglplus::BlendEquation eq)
	Sets the blend equation.
static void	BlendEquation (GLuint buffer, oglplus::BlendEquation eq)
	Sets the blend equation for a particular draw buffer.
static void	BlendEquationSeparate (oglplus::BlendEquation eq_rgb, oglplus::BlendEquation eq_alpha)
	Sets the blend equation separate for RGB and alpha.
static void	BlendEquationSeparate (GLuint buffer, oglplus::BlendEquation eq_rgb, oglplus::BlendEquation eq_alpha)
	Sets the blend equation separate for RGB and alpha for a buffer.
static void	BlendFunc (BlendFunction src, BlendFunction dst)
	Sets the blend function.
static void	BlendFunc (GLuint buffer, BlendFunction src, BlendFunction dst)
	Sets the blend function for a particular buffer.
static void	BlendFuncSeparate (BlendFunction src_rgb, BlendFunction dst_rgb, BlendFunction src_alpha, BlendFunction dst_alpha)
	Sets the blend function separate for RGB and alpha.
static void	BlendFuncSeparate (GLuint buffer, BlendFunction src_rgb, BlendFunction dst_rgb, BlendFunction src_alpha, BlendFunction dst_alpha)
	Sets the blend function separate for RGB and alpha for a buffer.
static void	BlendColor (GLclampf r, GLclampf g, GLclampf b, GLclampf a)
	Sets the blend color.
static void	MemoryBarrier (Bitfield< MemoryBarrierBit > bits)
	Defines a barrier for memory transactions.
static void	Flush (void)
	Indicate that all previous GL commands must finish in finite time.
static void	Finish (void)
	Force all previous GL commands to complete before returning.
static void	Hint (HintTarget target, HintOption option)
	Selects a hint option for a target.
static HintOption	Hint (HintTarget target)
	Queries the current hint for a target.
static GLint	IntLimit (LimitQuery query)
	Gets the implementation-dependent limit value.
static GLint	IntLimit (LimitQuery query, GLuint index)
	Gets the implementation-dependent indexed limit value.
static GLfloat	FloatLimit (LimitQuery query)
	Gets the implementation-dependent limit value.
static GLfloat	FloatLimit (LimitQuery query, GLuint index)
	Gets the implementation-dependent indexed limit value.
static void	RequireAtLeast (LimitQuery limit, GLint value)
	Raises a LimitError if value is greater than the specified limit.
static void	RequireAtLeast (LimitQuery limit, GLuint index, GLint value)
	Raises a LimitError if value is greater than the specified limit.
static const GLubyte *	GetString (StringQuery query)
	Queries a string describing GL properties.
static GLint	MajorVersion (void)
	Queries the major version number.
static GLint	MinorVersion (void)
	Queries the minor version number.
static GLuint	NumExtensions (void)
	Queries the number of extension strings.
static const GLubyte *	Extensions (GLuint index)
	Returns the name of the index -th extension.

---

Detailed Description

Wrapper for the current OpenGL context operations.

Examples:

standalone/001_triangle_glut_glew.cpp, standalone/001_triangle_sdl_glew.cpp, standalone/001_triangle_wxgl_glew.cpp, standalone/002_amd_perf_monitor.cpp, standalone/002_rectangle_glut_glew.cpp, standalone/002_simple_path.cpp, standalone/002_triangle_compatibility.cpp, standalone/003_simple_text.cpp, standalone/004_any_text_rendering.cpp, standalone/004_bitmap_text_hello.cpp, standalone/004_bitmap_text_rendering.cpp, standalone/004_pango_cairo_hello.cpp, standalone/004_stbttf_text_rendering.cpp, standalone/004_text_rendering.cpp, standalone/007_glm_boxes.cpp, standalone/025_bitmap_font_text.cpp, and standalone/026_blender_mesh_loader.cpp.

---

Member Function Documentation

static void oglplus::context::Blending::BlendColor	(	GLclampf	r,
		GLclampf	g,
		GLclampf	b,
		GLclampf	a
	)		[static, inherited]

Sets the blend color.

Related OpenGL symbols:

glBlendColor

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendEquation

(

oglplus::BlendEquation

eq

)

[static, inherited]

Sets the blend equation.

Related OpenGL symbols:

glBlendEquation

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendEquation	(	GLuint	buffer,
		oglplus::BlendEquation	eq
	)		[static, inherited]

Sets the blend equation for a particular draw buffer.

Requires OpenGL 4.0.

Related OpenGL symbols:

glBlendEquationi

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendEquationSeparate	(	oglplus::BlendEquation	eq_rgb,
		oglplus::BlendEquation	eq_alpha
	)		[static, inherited]

Sets the blend equation separate for RGB and alpha.

Related OpenGL symbols:

glBlendEquationSeparate

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendEquationSeparate	(	GLuint	buffer,
		oglplus::BlendEquation	eq_rgb,
		oglplus::BlendEquation	eq_alpha
	)		[static, inherited]

Sets the blend equation separate for RGB and alpha for a buffer.

Requires OpenGL 4.0.

Related OpenGL symbols:

glBlendEquationSeparatei

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendFunc	(	BlendFunction	src,
		BlendFunction	dst
	)		[static, inherited]

Sets the blend function.

Related OpenGL symbols:

glBlendFunc

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendFunc	(	GLuint	buffer,
		BlendFunction	src,
		BlendFunction	dst
	)		[static, inherited]

Sets the blend function for a particular buffer.

Requires OpenGL 4.0.

Related OpenGL symbols:

glBlendFunci

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendFuncSeparate	(	BlendFunction	src_rgb,
		BlendFunction	dst_rgb,
		BlendFunction	src_alpha,
		BlendFunction	dst_alpha
	)		[static, inherited]

Sets the blend function separate for RGB and alpha.

Related OpenGL symbols:

glBlendFuncSeparate

References OGLPLUS_VERIFY.

static void oglplus::context::Blending::BlendFuncSeparate	(	GLuint	buffer,
		BlendFunction	src_rgb,
		BlendFunction	dst_rgb,
		BlendFunction	src_alpha,
		BlendFunction	dst_alpha
	)		[static, inherited]

Sets the blend function separate for RGB and alpha for a buffer.

Requires OpenGL 4.0.

Related OpenGL symbols:

glBlendFuncSeparatei

References OGLPLUS_VERIFY.

static void oglplus::context::PixelOps::BlitFramebuffer	(	GLint	srcX0,
		GLint	srcY0,
		GLint	srcX1,
		GLint	srcY1,
		GLint	dstX0,
		GLint	dstY0,
		GLint	dstX1,
		GLint	dstY1,
		Bitfield< oglplus::BufferSelectBit >	mask,
		BlitFilter	filter
	)		[static, inherited]

Transfers a rectangle of pixels from the read buffer the draw buffer.

Related OpenGL symbols:

glBlitFramebuffer

References OGLPLUS_CHECK.

static ClrBits oglplus::context::ClearBuffers::Clear

(

void

)

[static, inherited]

Clears buffers specified by calling functions of the returned object.

This function returns an object that allows to specify which buffers to clear by calling its ColorBuffer, DepthBuffer and StencilBuffer member functions.

example:

  Context gl;
  gl.Clear().ColorBuffer();
  gl.Clear().ColorBuffer().DepthBuffer();
  gl.Clear().StencilBuffer().DepthBuffer();
  gl.Clear().ColorBuffer().DepthBuffer().StencilBuffer();

Exceptions:

Error

See also:

ClearColor

ClearDepth

ClearStencil

Related OpenGL symbols:

glClear

Examples:

standalone/002_amd_perf_monitor.cpp.

Referenced by oglplus::context::ClearBuffers::Clear().

static void oglplus::context::ClearBuffers::Clear

(

Bitfield< oglplus::ClearBit >

bits

)

[static, inherited]

Clears buffers specified by the bits parameter.

This function clears the specified buffers.

example:

  Context gl;
  gl.Clear(ClearBit::ColorBuffer);
  gl.Clear(ClearBit::ColorBuffer|ClearBit::DepthBuffer);
  gl.Clear({ClearBit::ColorBuffer});
  gl.Clear({ClearBit::ColorBuffer, ClearBit::DepthBuffer});
  gl.Clear({ClearBit::ColorBuffer, ClearBit::StencilBuffer});

Exceptions:

Error

See also:

ClearColor

ClearDepth

ClearStencil

Related OpenGL symbols:

glClear

References oglplus::context::ClearBuffers::Clear(), and OGLPLUS_VERIFY.

static void oglplus::context::ClearBuffers::ClearColor	(	GLclampf	r,
		GLclampf	g,
		GLclampf	b,
		GLclampf	a
	)		[static, inherited]

Sets the clear color.

Exceptions:

Error

Related OpenGL symbols:

glClearColor

References OGLPLUS_VERIFY.

static void oglplus::context::ClearBuffers::ClearDepth

(

GLclampd

d

)

[static, inherited]

Sets the clear depth.

Exceptions:

Error

Related OpenGL symbols:

glClearDepth

References OGLPLUS_VERIFY.

static void oglplus::context::ClearBuffers::ClearStencil

(

GLint

s

)

[static, inherited]

Sets the clear stencil buffer value.

Exceptions:

Error

Related OpenGL symbols:

glClearStencil

References OGLPLUS_VERIFY.

static GLint oglplus::context::ClearBuffers::ClearStencilValue

(

void

)

[static, inherited]

Returns the value used for clearing of the stencil buffer.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_STENCIL_CLEAR_VALUE

References OGLPLUS_VERIFY.

static oglplus::context::RGBAValue oglplus::context::ClearBuffers::ColorClearValue

(

void

)

[static, inherited]

Returns the color value used for clearing of the color buffer.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_COLOR_CLEAR_VALUE

References OGLPLUS_VERIFY.

static void oglplus::context::BufferMasking::ColorMask	(	bool	r,
		bool	g,
		bool	b,
		bool	a
	)		[static, inherited]

Sets the color mask.

Related OpenGL symbols:

glColorMask

References OGLPLUS_VERIFY.

static void oglplus::context::BufferMasking::ColorMask	(	GLuint	buffer,
		bool	r,
		bool	g,
		bool	b,
		bool	a
	)		[static, inherited]

Sets the color mask for a particular buffer.

Related OpenGL symbols:

glColorMaski

References OGLPLUS_VERIFY.

static oglplus::context::RGBAMask oglplus::context::BufferMasking::ColorWriteMask

(

GLuint

buffer = 0

)

[static, inherited]

Returns the value of color buffer write mask.

Related OpenGL symbols:

glGet GL_COLOR_WRITEMASK

References OGLPLUS_CHECK.

static void oglplus::context::Rasterization::CullFace

(

Face

mode

)

[static, inherited]

Sets the face culling mode.

Related OpenGL symbols:

glCullFace

References OGLPLUS_VERIFY.

static Face oglplus::context::Rasterization::CullFaceMode

(

void

)

[static, inherited]

Returns the face culling mode.

Related OpenGL symbols:

glGet GL_CULL_FACE_MODE

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::ClearBuffers::DepthClearValue

(

void

)

[static, inherited]

Returns the depth value used for clearing of the depth buffer.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_DEPTH_CLEAR_VALUE

References OGLPLUS_VERIFY.

static void oglplus::context::DepthTest::DepthFunc

(

CompareFunction

function

)

[static, inherited]

Sets the depth comparison function.

Related OpenGL symbols:

glDepthFunc

References oglplus::context::DepthTest::DepthFunc(), and OGLPLUS_VERIFY.

static CompareFunction oglplus::context::DepthTest::DepthFunc

(

void

)

[static, inherited]

Returns the depth comparison function.

Related OpenGL symbols:

glGet GL_DEPTH_FUNC

References OGLPLUS_VERIFY.

Referenced by oglplus::context::DepthTest::DepthFunc().

static void oglplus::context::BufferMasking::DepthMask

(

bool

mask

)

[static, inherited]

Sets the depth mask.

Related OpenGL symbols:

glDepthMask

References OGLPLUS_VERIFY.

static void oglplus::context::ViewportOps::DepthRange	(	GLclampf	near_val,
		GLclampf	far_val
	)		[static, inherited]

Sets the near_val / far_val depth range of the default viewport.

Exceptions:

Error

Related OpenGL symbols:

glDepthRangef

References OGLPLUS_CHECK.

static void oglplus::context::ViewportOps::DepthRange	(	GLclampd	near_val,
		GLclampd	far_val
	)		[static, inherited]

Sets the near_val / far_val depth range of the default viewport.

Exceptions:

Error

Related OpenGL symbols:

glDepthRangef

References OGLPLUS_CHECK.

static void oglplus::context::ViewportOps::DepthRange	(	GLuint	viewport,
		GLclampd	near_val,
		GLclampd	far_val
	)		[static, inherited]

Sets the near_val / far_val depth range of a viewport.

Exceptions:

Error

Related OpenGL symbols:

glDepthRangeIndexed

References OGLPLUS_CHECK.

static oglplus::context::DepthRange oglplus::context::ViewportOps::DepthRange

(

GLuint

viewport

)

[static, inherited]

Returns the depth range of the specified viewport.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_DEPTH_RANGE

References OGLPLUS_CHECK.

static void oglplus::context::ViewportOps::DepthRangeArray	(	GLuint	first,
		GLsizei	count,
		const GLclampd *	v
	)		[static, inherited]

Sets depth ranges of viewports specified by first and count.

Exceptions:

Error

Related OpenGL symbols:

glDepthRangeArrayv

References OGLPLUS_CHECK.

static bool oglplus::context::BufferMasking::DepthWriteMask

(

void

)

[static, inherited]

Returns the value of depth buffer write mask.

Related OpenGL symbols:

glGet GL_DEPTH_WRITEMASK

References OGLPLUS_VERIFY.

static void oglplus::context::Capabilities::Disable

(

Capability

capability

)

[static, inherited]

Disable a capability.

Related OpenGL symbols:

glDisable

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Capabilities::Disable().

static void oglplus::context::Capabilities::Disable	(	Functionality	functionality,
		GLuint	offset
	)		[static, inherited]

Disable a functionality.

Related OpenGL symbols:

glDisable

References oglplus::context::Capabilities::Disable(), and OGLPLUS_VERIFY.

static void oglplus::context::Capabilities::Disable	(	Capability	capability,
		GLuint	index
	)		[static, inherited]

Disable a capability for an indexed target.

Related OpenGL symbols:

glDisablei

References OGLPLUS_VERIFY.

static void oglplus::context::Computing::DispatchCompute	(	GLuint	num_groups_x,
		GLuint	num_groups_y,
		GLuint	num_groups_z
	)		[static, inherited]

Launches several work groups.

Related OpenGL symbols:

glDispatchCompute

References OGLPLUS_CHECK.

static void oglplus::context::Computing::DispatchComputeIndirect

(

GLintptr

indirect

)

[static, inherited]

Launches indirectly several work groups.

Related OpenGL symbols:

glDispatchComputeIndirect

References OGLPLUS_CHECK.

static void oglplus::context::Drawing::DrawArrays	(	PrimitiveType	primitive,
		GLint	first,
		GLsizei	count
	)		[static, inherited]

Draws count of primitives from the bound array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawArrays

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawArraysIndirect	(	PrimitiveType	primitive,
		const void *	indirect = nullptr
	)		[static, inherited]

Draws primitives from an indirect buffer.

Exceptions:

Error

Requires OpenGL 4.0 or the GL_ARB_draw_indirect extension.

Related OpenGL symbols:

glDrawArraysIndirect

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawArraysInstanced	(	PrimitiveType	primitive,
		GLint	first,
		GLsizei	count,
		GLsizei	inst_count
	)		[static, inherited]

Draws count of primitives from the bound array buffers.

Exceptions:

Error

Requires OpenGL 3.1.

Related OpenGL symbols:

glDrawArraysInstanced

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawArraysInstancedBaseInstance	(	PrimitiveType	primitive,
		GLint	first,
		GLsizei	count,
		GLsizei	inst_count,
		GLsizei	base_instance
	)		[static, inherited]

Draws count of primitives from the bound array buffers.

Exceptions:

Error

Requires OpenGL 4.2.

Related OpenGL symbols:

glDrawArraysInstancedBaseInstance

References OGLPLUS_VERIFY.

static void oglplus::context::BufferSelection::DrawBuffer

(

ColorBuffer

buffer

)

[static, inherited]

Sets the destination color buffer for draw operations.

Related OpenGL symbols:

glDrawBuffer

References OGLPLUS_VERIFY.

template<unsigned N>

static void oglplus::context::BufferSelection::DrawBuffers

(

ColorBuffer(&)

buffers[N]

)

[static, inherited]

Sets the destination color buffers for draw operations.

Related OpenGL symbols:

glDrawBuffers

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElements	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawElements

Examples:

standalone/025_bitmap_font_text.cpp.

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElements().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElements	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawElements

References oglplus::context::Drawing::DrawElements(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsBaseVertex	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawElementsBaseVertex

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElementsBaseVertex().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElementsBaseVertex	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawElementsBaseVertex

References oglplus::context::Drawing::DrawElementsBaseVertex(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsIndirect	(	PrimitiveType	primitive,
		DataType	data_type,
		const void *	indirect = nullptr
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.0 or the GL_ARB_GL_ARB_draw_indirect extension.

Related OpenGL symbols:

glDrawElementsIndirect

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsInstanced	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type,
		GLsizei	instance_count
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawElementsInstanced

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElementsInstanced().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElementsInstanced	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices,
		GLsizei	instance_count
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawElementsInstanced

References oglplus::context::Drawing::DrawElementsInstanced(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsInstancedBaseInstance	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type,
		GLsizei	inst_count,
		GLuint	base_instance
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.2.

Related OpenGL symbols:

glDrawElementsInstancedBaseInstance

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElementsInstancedBaseInstance().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElementsInstancedBaseInstance	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices,
		GLsizei	inst_count,
		GLuint	base_instance
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.2.

Related OpenGL symbols:

glDrawElementsInstancedBaseInstance

References oglplus::context::Drawing::DrawElementsInstancedBaseInstance(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsInstancedBaseVertex	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type,
		GLsizei	inst_count,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawElementsInstancedBaseVertex

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElementsInstancedBaseVertex().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElementsInstancedBaseVertex	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices,
		GLsizei	inst_count,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawElementsInstancedBaseVertex

References oglplus::context::Drawing::DrawElementsInstancedBaseVertex(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawElementsInstancedBaseVertexBaseInstance	(	PrimitiveType	primitive,
		GLsizei	count,
		DataType	data_type,
		GLsizei	inst_count,
		GLint	base_vertex,
		GLuint	base_instance
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.2.

Related OpenGL symbols:

glDrawElementsInstancedBaseVertexBaseInstance

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawElementsInstancedBaseVertexBaseInstance().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawElementsInstancedBaseVertexBaseInstance	(	PrimitiveType	primitive,
		GLsizei	count,
		const T *	indices,
		GLsizei	inst_count,
		GLint	base_vertex,
		GLuint	base_instance
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.2.

Related OpenGL symbols:

glDrawElementsInstancedBaseVertexBaseInstance

References oglplus::context::Drawing::DrawElementsInstancedBaseVertexBaseInstance(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawRangeElements	(	PrimitiveType	primitive,
		GLuint	start,
		GLuint	end,
		GLsizei	count,
		DataType	data_type
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawRangeElements

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawRangeElements().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawRangeElements	(	PrimitiveType	primitive,
		GLuint	start,
		GLuint	end,
		GLsizei	count,
		const T *	indices
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glDrawRangeElements

References oglplus::context::Drawing::DrawRangeElements(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::DrawRangeElementsBaseVertex	(	PrimitiveType	primitive,
		GLuint	start,
		GLuint	end,
		GLsizei	count,
		DataType	data_type,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawRangeElementsBaseVertex

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::DrawRangeElementsBaseVertex().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::DrawRangeElementsBaseVertex	(	PrimitiveType	primitive,
		GLuint	start,
		GLuint	end,
		GLsizei	count,
		const T *	indices,
		GLint	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glDrawRangeElementsBaseVertex

References oglplus::context::Drawing::DrawRangeElementsBaseVertex(), and OGLPLUS_VERIFY.

static void oglplus::context::Capabilities::Enable

(

Capability

capability

)

[static, inherited]

Enable a capability.

Related OpenGL symbols:

glEnable

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Capabilities::Enable().

static void oglplus::context::Capabilities::Enable	(	Functionality	functionality,
		GLuint	offset
	)		[static, inherited]

Enable a functionality.

Related OpenGL symbols:

glEnable

References oglplus::context::Capabilities::Enable(), and OGLPLUS_VERIFY.

static void oglplus::context::Capabilities::Enable	(	Capability	capability,
		GLuint	index
	)		[static, inherited]

Enable a capability for an indexed target.

Related OpenGL symbols:

glEnablei

References OGLPLUS_VERIFY.

static const GLubyte* oglplus::context::StringQueries::Extensions

(

GLuint

index

)

[static, inherited]

Returns the name of the index -th extension.

Exceptions:

Error

See also:

NumExtensions

Related OpenGL symbols:

glGetStringi GL_EXTENSIONS

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::LimitQueries::FloatLimit

(

LimitQuery

query

)

[static, inherited]

Gets the implementation-dependent limit value.

Related OpenGL symbols:

glGet

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::LimitQueries::FloatLimit	(	LimitQuery	query,
		GLuint	index
	)		[static, inherited]

Gets the implementation-dependent indexed limit value.

Related OpenGL symbols:

glGet

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::FrontFace

(

FaceOrientation

orientation

)

[static, inherited]

Sets the polygon facing mode.

Related OpenGL symbols:

glFrontFace

References OGLPLUS_VERIFY.

static ErrorCode oglplus::context::Errors::GetError

(

void

)

[static, inherited]

returns the error code

Related OpenGL symbols:

glGetError

static const GLubyte* oglplus::context::StringQueries::GetString

(

StringQuery

query

)

[static, inherited]

Queries a string describing GL properties.

Exceptions:

Error

Related OpenGL symbols:

glGetString

References OGLPLUS_VERIFY.

static void oglplus::context::Hints::Hint	(	HintTarget	target,
		HintOption	option
	)		[static, inherited]

Selects a hint option for a target.

Exceptions:

Error

Related OpenGL symbols:

glHint

References OGLPLUS_VERIFY.

static HintOption oglplus::context::Hints::Hint

(

HintTarget

target

)

[static, inherited]

Queries the current hint for a target.

Exceptions:

Error

Related OpenGL symbols:

glHint

References OGLPLUS_VERIFY.

static GLint oglplus::context::LimitQueries::IntLimit

(

LimitQuery

query

)

[static, inherited]

Gets the implementation-dependent limit value.

Related OpenGL symbols:

glGet

References OGLPLUS_VERIFY.

Referenced by oglplus::context::LimitQueries::RequireAtLeast().

static GLint oglplus::context::LimitQueries::IntLimit	(	LimitQuery	query,
		GLuint	index
	)		[static, inherited]

Gets the implementation-dependent indexed limit value.

Related OpenGL symbols:

glGet

References OGLPLUS_VERIFY.

static bool oglplus::context::Capabilities::IsEnabled

(

Capability

capability

)

[static, inherited]

Checks if a capability is enabled.

Related OpenGL symbols:

glIsEnabled

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Capabilities::IsEnabled().

static bool oglplus::context::Capabilities::IsEnabled	(	Functionality	functionality,
		GLuint	offset
	)		[static, inherited]

Checks if a functionality is enabled.

Related OpenGL symbols:

glIsEnabled

References oglplus::context::Capabilities::IsEnabled(), and OGLPLUS_VERIFY.

static bool oglplus::context::Capabilities::IsEnabled	(	Capability	capability,
		GLuint	index
	)		[static, inherited]

Check if a capability is enabled for indexed target.

Related OpenGL symbols:

glIsEnabledi

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::LineWidth

(

GLfloat

width

)

[static, inherited]

Sets the line width.

Related OpenGL symbols:

glLineWidth

References oglplus::context::Rasterization::LineWidth(), and OGLPLUS_VERIFY.

static GLfloat oglplus::context::Rasterization::LineWidth

(

void

)

[static, inherited]

Returns the line width.

Related OpenGL symbols:

glGet GL_LINE_WIDTH

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Rasterization::LineWidth().

static void oglplus::context::LogicalOps::LogicOp

(

ColorLogicOperation

op

)

[static, inherited]

Sets the color logical operation.

Related OpenGL symbols:

glLogicOp

References OGLPLUS_VERIFY.

static ColorLogicOperation oglplus::context::LogicalOps::LogicOpMode

(

void

)

[static, inherited]

Returns the color logical operation.

Related OpenGL symbols:

glGet GL_COLOR_LOGIC_OP

References OGLPLUS_VERIFY.

static GLint oglplus::context::StringQueries::MajorVersion

(

void

)

[static, inherited]

Queries the major version number.

Exceptions:

Error

See also:

MinorVersion

Related OpenGL symbols:

glGet GL_MAJOR_VERSION

References OGLPLUS_VERIFY.

static ViewportSize oglplus::context::ViewportOps::MaxViewportDims

(

void

)

[static, inherited]

Returns the implementation-dependent maximum viewport dimensions.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_MAX_VIEWPORT_DIMS

References OGLPLUS_VERIFY.

static GLuint oglplus::context::ViewportOps::MaxViewports

(

void

)

[static, inherited]

Returns the number of available viewports.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_MAX_VIEWPORTS

References OGLPLUS_VERIFY.

static void oglplus::context::Synchronization::MemoryBarrier

(

Bitfield< MemoryBarrierBit >

bits

)

[static, inherited]

Defines a barrier for memory transactions.

example:

  Context gl;
  gl.MemoryBarrier({MemoryBarrierBit::VertexAttribArray});
  gl.MemoryBarrier({
      MemoryBarrierBit::ElementArray,
      MemoryBarrierBit::Uniform
  });
  gl.MemoryBarrier({
      MemoryBarrierBit::TextureFetch,
      MemoryBarrierBit::TextureUpdate
  });

Exceptions:

Error

Requires OpenGL 4.2 or the GL_ARB_shader_image_load_store extension.

Related OpenGL symbols:

glMemoryBarrier

References OGLPLUS_VERIFY.

static GLint oglplus::context::StringQueries::MinorVersion

(

void

)

[static, inherited]

Queries the minor version number.

Exceptions:

Error

See also:

MajorVersion

Related OpenGL symbols:

glGet GL_MINOR_VERSION

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::MultiDrawArrays	(	PrimitiveType	primitive,
		const GLint *	first,
		const GLsizei *	count,
		GLsizei	primcount
	)		[static, inherited]

Draws primcount ranges of primitives from the bound array buffers.

Exceptions:

Error

See also:

DrawArrays

Related OpenGL symbols:

glMultiDrawArrays

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::MultiDrawArraysIndirect	(	PrimitiveType	primitive,
		GLsizei	draw_count,
		GLsizei	stride = 0,
		const void *	indirect = nullptr
	)		[static, inherited]

Draws multiple sets of primitives from an indirect buffer.

Exceptions:

Error

Requires OpenGL 4.3 or the GL_ARB_multi_draw_indirect extension.

Related OpenGL symbols:

glMultiDrawArraysIndirect

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::MultiDrawElements	(	PrimitiveType	primitive,
		const GLsizei *	count,
		DataType	data_type,
		GLsizei	draw_count
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glMultiDrawElements

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::MultiDrawElements().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::MultiDrawElements	(	PrimitiveType	primitive,
		const GLsizei *	count,
		T *const *	indices,
		GLsizei	draw_count
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Related OpenGL symbols:

glMultiDrawElements

References oglplus::context::Drawing::MultiDrawElements(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::MultiDrawElementsBaseVertex	(	PrimitiveType	primitive,
		const GLsizei *	count,
		DataType	data_type,
		GLsizei	draw_count,
		const GLint *	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glMultiDrawElementsBaseVertex

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Drawing::MultiDrawElementsBaseVertex().

template<typename T >

static std::enable_if<IsGLDataType<T>::value, void>::type oglplus::context::Drawing::MultiDrawElementsBaseVertex	(	PrimitiveType	primitive,
		const GLsizei *	count,
		T *const *	indices,
		GLsizei	draw_count,
		const GLint *	base_vertex
	)		[static, inherited]

Draws a sequence of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 3.2 or the GL_ARB_draw_elements_base_vertex extension.

Related OpenGL symbols:

glMultiDrawElementsBaseVertex

References oglplus::context::Drawing::MultiDrawElementsBaseVertex(), and OGLPLUS_VERIFY.

static void oglplus::context::Drawing::MultiDrawElementsIndirect	(	PrimitiveType	primitive,
		DataType	data_type,
		GLsizei	draw_count,
		GLsizei	stride = 0,
		const void *	indirect = nullptr
	)		[static, inherited]

Draws sequences of primitives from the bound element array buffers.

Exceptions:

Error

Requires OpenGL 4.3.

Related OpenGL symbols:

glMultiDrawElementsIndirect

References OGLPLUS_VERIFY.

static GLuint oglplus::context::StringQueries::NumExtensions

(

void

)

[static, inherited]

Queries the number of extension strings.

Exceptions:

Error

See also:

GetExtension

Related OpenGL symbols:

glGet GL_NUM_EXTENSIONS

References OGLPLUS_VERIFY.

static void oglplus::context::PixelOps::PixelStore	(	PixelStorageMode	parameter,
		GLfloat	value
	)		[static, inherited]

Sets the value of a pixel storage parameter.

Related OpenGL symbols:

glPixelStore

References OGLPLUS_CHECK.

static void oglplus::context::PixelOps::PixelStore	(	PixelStorageMode	parameter,
		GLint	value
	)		[static, inherited]

Sets the value of a pixel storage parameter.

Related OpenGL symbols:

glPixelStore

References OGLPLUS_CHECK.

static void oglplus::context::Rasterization::PointFadeThresholdSize

(

GLfloat

size

)

[static, inherited]

Sets the point fade threshold size.

Related OpenGL symbols:

glPointParameter GL_POINT_FADE_THRESHOLD_SIZE

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::Rasterization::PointFadeThresholdSize

(

void

)

[static, inherited]

Returns the point fade threshold size.

Related OpenGL symbols:

glGet GL_POINT_FADE_THRESHOLD_SIZE

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::PointSize

(

GLfloat

size

)

[static, inherited]

Sets the point size.

Related OpenGL symbols:

glPointSize

References OGLPLUS_VERIFY, and oglplus::context::Rasterization::PointSize().

static GLfloat oglplus::context::Rasterization::PointSize

(

void

)

[static, inherited]

Returns the point size.

Related OpenGL symbols:

glGet GL_POINT_SIZE

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Rasterization::PointSize().

static void oglplus::context::Rasterization::PolygonMode	(	Face	face,
		oglplus::PolygonMode	mode
	)		[static, inherited]

Sets the polygon rasterization mode.

Related OpenGL symbols:

glPolygonMode

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::PolygonMode

(

oglplus::PolygonMode

mode

)

[static, inherited]

Sets the polygon rasterization mode.

Related OpenGL symbols:

glPolygonMode

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::PolygonOffset	(	GLfloat	factor,
		GLfloat	units
	)		[static, inherited]

Sets the polygon depth offset.

Related OpenGL symbols:

glPolygonOffset

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::Rasterization::PolygonOffsetFactor

(

void

)

[static, inherited]

Returns the polygon offset factor.

Related OpenGL symbols:

glGet GL_POLYGON_OFFSET_FACTOR

References OGLPLUS_VERIFY.

static GLfloat oglplus::context::Rasterization::PolygonOffsetUnits

(

void

)

[static, inherited]

Returns the polygon offset units.

Related OpenGL symbols:

glGet GL_POLYGON_OFFSET_UNITS

References OGLPLUS_VERIFY.

static void oglplus::context::Drawing::PrimitiveRestartIndex

(

GLuint

index

)

[static, inherited]

Sets the primitive restart index.

Exceptions:

Error

Requires OpenGL 3.1.

Related OpenGL symbols:

glPrimitiveRestartIndex

References OGLPLUS_VERIFY.

static void oglplus::context::Rasterization::ProvokingVertex

(

ProvokeMode

mode

)

[static, inherited]

Sets the provoking vertex selection mode for flatshading.

Requires OpenGL 3.2 or the GL_ARB_provoking_vertex extension.

Related OpenGL symbols:

glProvokingVertex

References OGLPLUS_VERIFY, and oglplus::context::Rasterization::ProvokingVertex().

static ProvokeMode oglplus::context::Rasterization::ProvokingVertex

(

void

)

[static, inherited]

Returns the provoking vertex selection mode for flatshading.

Requires OpenGL 3.2 or the GL_ARB_provoking_vertex extension.

Related OpenGL symbols:

glGet GL_PROVOKING_VERTEX

References OGLPLUS_VERIFY.

Referenced by oglplus::context::Rasterization::ProvokingVertex().

static void oglplus::context::BufferSelection::ReadBuffer

(

ColorBuffer

buffer

)

[static, inherited]

Sets the source color buffer for read operations.

Related OpenGL symbols:

glReadBuffer

References OGLPLUS_VERIFY.

static void oglplus::context::PixelOps::ReadPixels	(	GLint	x,
		GLint	y,
		GLsizei	width,
		GLsizei	height,
		PixelDataFormat	format,
		PixelDataType	type,
		void *	data
	)		[static, inherited]

Sets the value of a pixel storage parameter.

Related OpenGL symbols:

glReadPixels

References OGLPLUS_CHECK.

static void oglplus::context::LimitQueries::RequireAtLeast	(	LimitQuery	limit,
		GLint	value
	)		[static, inherited]

Raises a LimitError if value is greater than the specified limit.

Related OpenGL symbols:

glGet

Exceptions:

LimitError

References oglplus::context::LimitQueries::IntLimit().

static void oglplus::context::LimitQueries::RequireAtLeast	(	LimitQuery	limit,
		GLuint	index,
		GLint	value
	)		[static, inherited]

Raises a LimitError if value is greater than the specified limit.

Related OpenGL symbols:

glGet

Exceptions:

LimitError

References oglplus::context::LimitQueries::IntLimit().

static void oglplus::context::ScissorTest::Scissor	(	GLint	left,
		GLint	bottom,
		GLsizei	width,
		GLsizei	height
	)		[static, inherited]

Defines the scissor rectangle for the first viewport.

Exceptions:

Error

Related OpenGL symbols:

glScissor

References OGLPLUS_VERIFY.

static void oglplus::context::ScissorTest::Scissor	(	GLuint	viewport,
		GLint	left,
		GLint	bottom,
		GLsizei	width,
		GLsizei	height
	)		[static, inherited]

Defines the scissor rectangle for the specified viewport.

Exceptions:

Error

Requires OpenGL 4.1 or the GL_ARB_viewport_array extension.

Related OpenGL symbols:

glScissorIndexed

References OGLPLUS_CHECK.

static void oglplus::context::ScissorTest::Scissor	(	GLuint	viewport,
		GLint *	v
	)		[static, inherited]

Defines the scissor rectangle for the specified viewport.

Requires OpenGL 4.1 or the GL_ARB_viewport_array extension.

Related OpenGL symbols:

glScissorIndexedv

References OGLPLUS_CHECK.

static void oglplus::context::ScissorTest::ScissorArray	(	GLuint	first,
		GLsizei	count,
		GLint *	v
	)		[static, inherited]

Defines scissor boxes for viewports specified by first count.

Exceptions:

Error

Requires OpenGL 4.1 or the GL_ARB_viewport_array extension.

Related OpenGL symbols:

glScissorArrayv

References OGLPLUS_CHECK.

static ScissorRectangle oglplus::context::ScissorTest::ScissorBox

(

GLuint

viewport

)

[static, inherited]

Returns the extents of scissor box of the specified viewport.

Exceptions:

Error

Requires OpenGL 4.1 or the GL_ARB_viewport_array extension.

Related OpenGL symbols:

glGet GL_SCISSOR_BOX

References OGLPLUS_CHECK.

static StencilOperation oglplus::context::StencilTest::StencilFail

(

bool

backface = false

)

[static, inherited]

Returns the stencil-fail action.

Related OpenGL symbols:

glGet GL_STENCIL_FAIL GL_STENCIL_BACK_FAIL

References OGLPLUS_VERIFY.

static void oglplus::context::StencilTest::StencilFunc	(	CompareFunction	func,
		GLint	ref = GLint(0),
		GLuint	mask = ~GLuint(0)
	)		[static, inherited]

Sets the stencil function.

Related OpenGL symbols:

glStencilFunc

References OGLPLUS_VERIFY.

static CompareFunction oglplus::context::StencilTest::StencilFunc

(

bool

backface = false

)

[static, inherited]

Returns the stencil function.

Related OpenGL symbols:

glGet GL_STENCIL_FUNC GL_STENCIL_BACK_FUNC

References OGLPLUS_VERIFY.

static void oglplus::context::StencilTest::StencilFuncSeparate	(	Face	face,
		CompareFunction	func,
		GLint	ref = GLint(0),
		GLuint	mask = ~GLuint(0)
	)		[static, inherited]

Sets the stencil function separately for front and back faces.

Related OpenGL symbols:

glStencilFuncSeparate

References OGLPLUS_VERIFY.

static void oglplus::context::BufferMasking::StencilMask

(

GLuint

mask

)

[static, inherited]

Sets the stencil mask.

Related OpenGL symbols:

glStencilMask

References OGLPLUS_VERIFY.

static void oglplus::context::BufferMasking::StencilMaskSeparate	(	Face	face,
		GLuint	mask
	)		[static, inherited]

Sets the stencil mask separately for front and back faces.

Related OpenGL symbols:

glStencilMaskSeparate

References OGLPLUS_VERIFY.

static void oglplus::context::StencilTest::StencilOp	(	StencilOperation	sfail,
		StencilOperation	dfail,
		StencilOperation	dpass
	)		[static, inherited]

Sets the stencil operation.

Related OpenGL symbols:

glStencilOp

References OGLPLUS_VERIFY.

static void oglplus::context::StencilTest::StencilOpSeparate	(	Face	face,
		StencilOperation	sfail,
		StencilOperation	dfail,
		StencilOperation	dpass
	)		[static, inherited]

Sets the stencil operation separately for front and back faces.

Related OpenGL symbols:

glStencilOpSeparate

References OGLPLUS_VERIFY.

static StencilOperation oglplus::context::StencilTest::StencilPassDepthFail

(

bool

backface = false

)

[static, inherited]

Returns the stencil-pass depth-fail action.

Related OpenGL symbols:

glGet GL_STENCIL_PASS_DEPTH_FAIL GL_STENCIL_BACK_PASS_DEPTH_FAIL

References OGLPLUS_VERIFY.

static StencilOperation oglplus::context::StencilTest::StencilPassDepthPass

(

bool

backface = false

)

[static, inherited]

Returns the stencil-pass depth-pass action.

Related OpenGL symbols:

glGet GL_STENCIL_PASS_DEPTH_PASS GL_STENCIL_BACK_PASS_DEPTH_PASS

References OGLPLUS_VERIFY.

static GLuint oglplus::context::StencilTest::StencilRef

(

bool

backface = false

)

[static, inherited]

Returns the stencil reference value.

Related OpenGL symbols:

glGet GL_STENCIL_REF GL_STENCIL_BACK_REF

References OGLPLUS_VERIFY.

static GLuint oglplus::context::StencilTest::StencilValueMask

(

bool

backface = false

)

[static, inherited]

Returns the value of stencil mask.

Related OpenGL symbols:

glGet GL_STENCIL_VALUE_MASK GL_STENCIL_BACK_VALUE_MASK

References OGLPLUS_VERIFY.

static GLuint oglplus::context::BufferMasking::StencilWriteMask

(

bool

backface = false

)

[static, inherited]

Returns the value of stencil write mask.

Related OpenGL symbols:

glGet GL_STENCIL_WRITEMASK GL_STENCIL_BACK_WRITEMASK

References OGLPLUS_VERIFY.

static void oglplus::context::ViewportOps::Viewport	(	GLint	x,
		GLint	y,
		GLsizei	w,
		GLsizei	h
	)		[static, inherited]

Sets the extents of the current viewport.

Exceptions:

Error

Related OpenGL symbols:

glViewport

References OGLPLUS_CHECK.

Referenced by oglplus::context::ViewportOps::Viewport().

static void oglplus::context::ViewportOps::Viewport	(	GLsizei	w,
		GLsizei	h
	)		[static, inherited]

Sets the size of the current viewport starting at (0,0)

Exceptions:

Error

Related OpenGL symbols:

glViewport

References OGLPLUS_CHECK, and oglplus::context::ViewportOps::Viewport().

static void oglplus::context::ViewportOps::Viewport	(	GLuint	viewport,
		GLfloat	x,
		GLfloat	y,
		GLfloat	width,
		GLfloat	height
	)		[static, inherited]

Sets the extents of the specified viewport.

Exceptions:

Error

Related OpenGL symbols:

glViewportIndexedf

References OGLPLUS_CHECK.

static void oglplus::context::ViewportOps::Viewport	(	GLuint	viewport,
		const GLfloat *	extents
	)		[static, inherited]

Sets the extents of the specified viewport.

Exceptions:

Error

Related OpenGL symbols:

glViewportIndexedfv

References OGLPLUS_CHECK.

static ViewportExtents oglplus::context::ViewportOps::Viewport

(

GLuint

viewport

)

[static, inherited]

Returns the extents of the specified viewport.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_VIEWPORT

References OGLPLUS_CHECK.

static void oglplus::context::ViewportOps::ViewportArray	(	GLuint	first,
		GLsizei	count,
		const GLfloat *	extents
	)		[static, inherited]

Sets extents of the viewports specified by first and count.

Exceptions:

Error

Related OpenGL symbols:

glViewportIndexedfv

References OGLPLUS_CHECK.

static ViewportPosition oglplus::context::ViewportOps::ViewportBoundsRange

(

void

)

[static, inherited]

Returns the implementation-dependent viewport bounds range.

Exceptions:

Error

Related OpenGL symbols:

glGet GL_VIEWPORT_BOUNDS_RANGE

References OGLPLUS_VERIFY.

---

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

• /home/chochlik/devel/oglplus/include/oglplus/context.hpp