SR::GLWeaver Class Reference

#include <glweaver.h>

Inheritance diagram for SR::GLWeaver:

Collaboration diagram for SR::GLWeaver:

Public Member Functions
	GLWeaver (SR::SRContext &context, unsigned int width, unsigned int height)
	Constructs a class to be used for weaving an input image of a certain size. More...
	GLWeaver (SR::SRContext &context, unsigned int width, unsigned int height, GLenum bufferFormat)
	Constructs a class to be used for weaving an input image of a certain size. More...
	~GLWeaver ()
	Handles proper destruction of all weaver related classes and buffers. More...
Public Member Functions inherited from SR::GLWeaverBase
	GLWeaverBase ()
	~GLWeaverBase ()
GLuint	getFrameBuffer ()
	Returns the buffer that will be used to create a weaved imaged. This buffer expects a side-by-side image. More...
void	setInputFrameBuffer (GLuint frameBufferID, GLuint renderedTextureID)
	Sets the buffer that will be used to create a weaved image. More...
void	setWindowHandle (HWND handle)
	Sets the window handle of the application window. If the weaver was created using a deprecated constructor, setting window handle has no effect. More...
void	setContrast (float contrast)
	Sets the weaving contrast. More...
float	getContrast () const
	Gets the current weaving contrast. More...
void	setShaderSRGBConversion (bool read, bool write)
	Sets whether to apply shader sRGB<->Linear color space conversions to the input framebuffer during weaving. More...
void	setACTMode (WeaverACTMode mode)
	Sets the anti-crosstalk mode. More...
WeaverACTMode	getACTMode () const
	Gets the anti-crosstalk mode. More...
void	setCrosstalkStaticFactor (float factor)
	Sets the anti-crosstalk factor. More...
float	getCrosstalkStaticFactor () const
	Gets the anti-crosstalk factor. More...
void	setCrosstalkDynamicFactor (float factor)
	Sets the anti-crosstalk dynamic factor. More...
float	getCrosstalkDynamicFactor () const
	Gets the anti-crosstalk dynamic factor. More...
bool	canWeave ()
	Used to determine if software weaving is possible on this device. More...
bool	canWeave (unsigned int width, unsigned int height)
	Used to determine if software weaving is possible for certain size and visibility to the currently bound framebuffer. More...
bool	canWeave (unsigned int width, unsigned int height, unsigned int xOffset, unsigned int yOffset)
	Used to determine if software weaving is possible for certain size and visibility to the currently bound framebuffer. More...
void	weave (unsigned int width, unsigned int height)
	Can be called to render a weaved image of a certain size to the currently bound framebuffer. More...
void	weave (unsigned int width, unsigned int height, unsigned int xOffset, unsigned int yOffset)
	Can be called to render a weaved image of a certain size to the currently bound framebuffer. More...
void	enableLateLatching (bool enable)
	Enables late latching. Note that late latching requires applications to call weave() once per frame, and does not work with deferred contexts. More...
bool	isLateLatchingEnabled () const
	Determines if late latching is enabled. More...

Static Public Member Functions
static GLWeaver *	create (SR::SRContext &context, unsigned int width, unsigned int height)
	Constructs a class to be used for weaving an input image of a certain size. More...

Additional Inherited Members
Protected Attributes inherited from SR::GLWeaverBase
std::unique_ptr< Impl >	pimpl

Constructor & Destructor Documentation

GLWeaver() [1/2]

SR::GLWeaver::GLWeaver	(	SR::SRContext &	context,
		unsigned int	width,
		unsigned int	height
	)

Constructs a class to be used for weaving an input image of a certain size.

Parameters

context	to connect to
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together

Exceptions

std::exception

if FrameBuffer did not initialize successfully, can be caused by using Opengl in parallel on another thread

GLWeaver() [2/2]

SR::GLWeaver::GLWeaver	(	SR::SRContext &	context,
		unsigned int	width,
		unsigned int	height,
		GLenum	bufferFormat
	)

Constructs a class to be used for weaving an input image of a certain size.

Parameters

context	to connect to
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together
bufferFormat	Format of the framebuffer

Exceptions

std::exception

if FrameBuffer did not initialize successfully, can be caused by using Opengl in parallel on another thread

~GLWeaver()

SR::GLWeaver::~GLWeaver

(

)

Handles proper destruction of all weaver related classes and buffers.

Member Function Documentation

create()

static GLWeaver * SR::GLWeaver::create ( SR::SRContext &  context, unsigned int  width, unsigned int  height  )

static

Constructs a class to be used for weaving an input image of a certain size.

Deprecated:

Calling delete on the returned pointer causes crashing, developers should use the constructor of GLWeaver directly

Parameters

context	to connect to, needs to be valid for the lifetime of the weaver object.
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together

Exceptions

std::exception

if FrameBuffer did not initialize successfully, can be caused by using Opengl in parallel on another thread

Returns

pointer to new GLWeaver instance

---

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

• glweaver.h