SR::DX11Weaver Class Reference

#include <dx11weaver.h>

Inheritance diagram for SR::DX11Weaver:

Collaboration diagram for SR::DX11Weaver:

Public Member Functions
	DX11Weaver (SR::SRContext &context, ID3D11Device *device, ID3D11DeviceContext *deviceContext, unsigned int width, unsigned int height)
	Constructs a class to be used for weaving an input image of a certain size. More...
	DX11Weaver (SR::SRContext &context, ID3D11Device *device, ID3D11DeviceContext *deviceContext, unsigned int width, unsigned int height, HWND window)
	Constructs a class to be used for weaving an input image of a certain size. More...
	DX11Weaver (SR::SRContext &context, ID3D11Device *device, ID3D11DeviceContext *deviceContext, unsigned int width, unsigned int height, DXGI_FORMAT format)
	Constructs a class to be used for weaving an input image of a certain size and format. More...
	DX11Weaver (SR::SRContext &context, ID3D11Device *device, ID3D11DeviceContext *deviceContext, unsigned int width, unsigned int height, DXGI_FORMAT format, HWND window)
	Constructs a class to be used for weaving an input image of a certain size and format. More...
	~DX11Weaver ()
	Handles proper destruction of all weaver related classes and buffers. More...
Public Member Functions inherited from SR::DX11WeaverBase
	DX11WeaverBase ()
	~DX11WeaverBase ()
ID3D11RenderTargetView *	getFrameBuffer ()
	Returns the buffer that will be used to create a weaved image. This buffer expects a side-by-side image. When a frame buffer is provided by calling setInputFrameBuffer(), the internally created buffer will be released. More...
void	setInputFrameBuffer (ID3D11ShaderResourceView *frameBuffer)
	Sets the buffer that will be used to create a weaved image. This will release the internally created frame buffer. More...
void	setContext (ID3D11DeviceContext *context)
	Sets the device context for the weaver to use. 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	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...
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 A framebuffer must be set before calling this function. 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 A framebuffer must be set before calling this function. More...

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

Constructor & Destructor Documentation

DX11Weaver() [1/4]

SR::DX11Weaver::DX11Weaver	(	SR::SRContext &	context,
		ID3D11Device *	device,
		ID3D11DeviceContext *	deviceContext,
		unsigned int	width,
		unsigned int	height
	)

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

Deprecated:

Parameters

context	to connect to, needs to be valid for the lifetime of the weaver object.
device	interface used to create resources
deviceContext	to be used for rendering commands
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together

DX11Weaver() [2/4]

SR::DX11Weaver::DX11Weaver	(	SR::SRContext &	context,
		ID3D11Device *	device,
		ID3D11DeviceContext *	deviceContext,
		unsigned int	width,
		unsigned int	height,
		HWND	window
	)

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

Parameters

context	to connect to
device	interface used to create resources
deviceContext	to be used for rendering commands
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together
window	Handle of the application window

DX11Weaver() [3/4]

SR::DX11Weaver::DX11Weaver	(	SR::SRContext &	context,
		ID3D11Device *	device,
		ID3D11DeviceContext *	deviceContext,
		unsigned int	width,
		unsigned int	height,
		DXGI_FORMAT	format
	)

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

Deprecated:

Parameters

context	to connect to
device	interface used to create resources
deviceContext	to be used for rendering commands
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together
format	of the side-by-side image to be weaved together

DX11Weaver() [4/4]

SR::DX11Weaver::DX11Weaver	(	SR::SRContext &	context,
		ID3D11Device *	device,
		ID3D11DeviceContext *	deviceContext,
		unsigned int	width,
		unsigned int	height,
		DXGI_FORMAT	format,
		HWND	window
	)

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

Deprecated:

Parameters

context	to connect to
device	interface used to create resources
deviceContext	to be used for rendering commands
width	of the side-by-side image to be weaved together
height	of the side-by-side image to be weaved together
format	of the side-by-side image to be weaved together
window	handle for windowed weaving support

~DX11Weaver()

SR::DX11Weaver::~DX11Weaver

(

)

Handles proper destruction of all weaver related classes and buffers.

---

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

• dx11weaver.h