Internals of the Context module. More...

Collaboration diagram for Context:

Files
file	context.c

file	message_callback.c

file	message_callback_p.h

void	srpNewContext (SRPContext *pContext)

void	srpSetMessageCallback (SRPMessageCallback callback)

void	srpProvokingVertexMode (SRPProvokingVertexMode mode)

void	srpRasterCullFace (SRPFace face)

void	srpRasterFrontFace (SRPWinding face)

void	srpRasterPolygonMode (SRPPolygonMode mode)

void	srpRasterPointSize (float size)

void	srpScissorTest (bool enable)

void	srpScissorOptions (size_t x, size_t y, size_t width, size_t height)

void	srpStencilTest (bool enable)

void	srpStencilFunc (SRPCompareOp func, uint8_t ref, uint8_t mask)

void	srpStencilFuncSeparate (SRPFace face, SRPCompareOp func, uint8_t ref, uint8_t mask)

void	srpStencilOp (SRPStencilOp sfail, SRPStencilOp dfail, SRPStencilOp pass)

void	srpStencilOpSeparate (SRPFace face, SRPStencilOp sfail, SRPStencilOp dfail, SRPStencilOp pass)

void	srpStencilWriteMask (uint8_t mask)

void	srpStencilWriteMaskSeparate (SRPFace face, uint8_t mask)

void	srpDepthTest (bool enable)

void	srpDepthWrite (bool enable)

void	srpDepthCompareOp (SRPCompareOp op)

void	srpMessageCallbackHelper (SRPMessageType type, SRPMessageSeverity severity, const char sourceFunction, const char format,...)

#define	MAX_CHARS_IN_MESSAGE 1024

Detailed Description

Internals of the Context module.

See also: Context

Function Documentation

◆ srpDepthCompareOp()

void srpDepthCompareOp ( SRPCompareOp op )

Set the compare operation used in the depth test

◆ srpDepthTest()

void srpDepthTest ( bool enable )

Enable or disable the depth test

◆ srpDepthWrite()

void srpDepthWrite ( bool enable )

Enable or disable the depth writing

◆ srpMessageCallbackHelper()

void srpMessageCallbackHelper	(	SRPMessageType	type,
		SRPMessageSeverity	severity,
		const char *	sourceFunction,
		const char *	format,
			...
	)

A helper function used by the library implementation to make callbacks easier

Parameters

[in]	type	Message type
[in]	severity	Message severity
[in]	sourceFunction	Function that is the source of this message
[in]	format	`printf`-like format string
[in]	...	Values passed to the format string

See also: SRPMessageCallbackFunc

◆ srpNewContext()

void srpNewContext ( SRPContext * pContext )

Initialize the context

Parameters

[in] pContext The pointer to the context

Todo:: use LESS here? like OpenGL

◆ srpProvokingVertexMode()

void srpProvokingVertexMode ( SRPProvokingVertexMode mode )

Set the provoking vertex convention

◆ srpRasterCullFace()

void srpRasterCullFace ( SRPFace face )

Set the face(s) to cull

◆ srpRasterFrontFace()

void srpRasterFrontFace ( SRPWinding face )

Set the winding order considered the front face

◆ srpRasterPointSize()

void srpRasterPointSize ( float size )

Set point size

◆ srpRasterPolygonMode()

void srpRasterPolygonMode ( SRPPolygonMode mode )

Set polygon rasterization mode

◆ srpScissorOptions()

void srpScissorOptions	(	size_t	x,
		size_t	y,
		size_t	width,
		size_t	height
	)

Set the options for the scissor test

◆ srpScissorTest()

void srpScissorTest ( bool enable )

Enable or disable the scissor test

◆ srpSetMessageCallback()

void srpSetMessageCallback ( SRPMessageCallback callback )

Set message callback function

◆ srpStencilFunc()

void srpStencilFunc	(	SRPCompareOp	func,
		uint8_t	ref,
		uint8_t	mask
	)

Set the stencil comparison function options

◆ srpStencilFuncSeparate()

void srpStencilFuncSeparate	(	SRPFace	face,
		SRPCompareOp	func,
		uint8_t	ref,
		uint8_t	mask
	)

Set the stencil comparison function options for a specific face type

◆ srpStencilOp()

void srpStencilOp	(	SRPStencilOp	sfail,
		SRPStencilOp	dfail,
		SRPStencilOp	pass
	)

Set the stencil update operation options

◆ srpStencilOpSeparate()

void srpStencilOpSeparate	(	SRPFace	face,
		SRPStencilOp	sfail,
		SRPStencilOp	dfail,
		SRPStencilOp	pass
	)

Set the stencil update operation options for a specific face type

◆ srpStencilTest()

void srpStencilTest ( bool enable )

Enable or disable the stencil test

◆ srpStencilWriteMask()

void srpStencilWriteMask ( uint8_t mask )

Set the write mask on stencil operations

◆ srpStencilWriteMaskSeparate()

void srpStencilWriteMaskSeparate	(	SRPFace	face,
		uint8_t	mask
	)

Set the write mask on stencil operations for a specific face type

Files