#include <dx11weaver.h>

Inheritance diagram for SR::DX11WeaverBase:

Public Member Functions
	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...

Protected Attributes
std::unique_ptr< Impl >	pimpl

Constructor & Destructor Documentation

◆ DX11WeaverBase()

SR::DX11WeaverBase::DX11WeaverBase ( )

◆ ~DX11WeaverBase()

SR::DX11WeaverBase::~DX11WeaverBase ( )

Member Function Documentation

◆ canWeave() [1/3]

bool SR::DX11WeaverBase::canWeave ( )

Used to determine if software weaving is possible on this device.

Deprecated:

Returns: bool indicating whether weaving can be done. Returns true when software weaving can be performed by DX11Weaver. When false is returned, you can output side-by-side manually or let DX11Weaver handle this.

◆ canWeave() [2/3]

bool SR::DX11WeaverBase::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.

Parameters

width	of the image to be rendered to the bound framebuffer
height	of the image to be rendered to the bound framebuffer

Exceptions

std::runtime_error if the window handle (HWND) becomes invalid during the execution of canWeave

Returns: bool indicating whether weaving can be done. Returns true when software weaving can be performed by DX11Weaver. When false is returned, you can output side-by-side manually or let DX11Weaver handle this.

◆ canWeave() [3/3]

bool SR::DX11WeaverBase::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.

Parameters

width	of the image to be rendered to the bound framebuffer
height	of the image to be rendered to the bound framebuffer
xOffset	of the image to be rendered to the bound framebuffer
yOffset	of the image to be rendered to the bound framebuffer

Exceptions

std::runtime_error if the window handle (HWND) becomes invalid during the execution of canWeave

Returns: bool indicating whether weaving can be done. Returns true when software weaving can be performed by DX11Weaver. When false is returned, you can output side-by-side manually or let DX11Weaver handle this.

◆ enableLateLatching()

void SR::DX11WeaverBase::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.

◆ getACTMode()

WeaverACTMode SR::DX11WeaverBase::getACTMode ( ) const

Gets the anti-crosstalk mode.

◆ getContrast()

float SR::DX11WeaverBase::getContrast ( ) const

Gets the current weaving contrast.

◆ getCrosstalkDynamicFactor()

float SR::DX11WeaverBase::getCrosstalkDynamicFactor ( ) const

Gets the anti-crosstalk dynamic factor.

◆ getCrosstalkStaticFactor()

float SR::DX11WeaverBase::getCrosstalkStaticFactor ( ) const

Gets the anti-crosstalk factor.

◆ getFrameBuffer()

ID3D11RenderTargetView * SR::DX11WeaverBase::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.

The buffer identifier can be bound using OMSetRenderTargets to start rendering to it. Rendering to the buffer is identical to normal rendering and often starts with calling ClearRenderTargetView.

Returns: ID3D11RenderTargetView identifying a buffer generated with CreateShaderResourceView

◆ isLateLatchingEnabled()

bool SR::DX11WeaverBase::isLateLatchingEnabled ( ) const

Determines if late latching is enabled.

◆ setACTMode()

void SR::DX11WeaverBase::setACTMode ( WeaverACTMode mode )

Sets the anti-crosstalk mode.

◆ setContext()

void SR::DX11WeaverBase::setContext ( ID3D11DeviceContext * context )

Sets the device context for the weaver to use.

Parameters

context Device Context to be used for rendering commands

◆ setContrast()

void SR::DX11WeaverBase::setContrast ( float contrast )

Sets the weaving contrast.

◆ setCrosstalkDynamicFactor()

void SR::DX11WeaverBase::setCrosstalkDynamicFactor ( float factor )

Sets the anti-crosstalk dynamic factor.

◆ setCrosstalkStaticFactor()

void SR::DX11WeaverBase::setCrosstalkStaticFactor ( float factor )

Sets the anti-crosstalk factor.

◆ setInputFrameBuffer()

void SR::DX11WeaverBase::setInputFrameBuffer ( ID3D11ShaderResourceView * frameBuffer )

Sets the buffer that will be used to create a weaved image. This will release the internally created frame buffer.

Parameters

frameBuffer Frame buffer to set

◆ setShaderSRGBConversion()

void SR::DX11WeaverBase::setShaderSRGBConversion	(	bool	read,
		bool	write
	)

Sets whether to apply shader sRGB<->Linear color space conversions to the input framebuffer during weaving.

Parameters

read	Convert from sRGB to Linear color space before weaving.
write	Convert from Linear to sRGB color space after weaving.

◆ setWindowHandle()

void SR::DX11WeaverBase::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.

Parameters

window Handle of the application window

◆ weave() [1/2]

void SR::DX11WeaverBase::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.

Parameters

width	of the image to be rendered to the bound framebuffer
height	of the image to be rendered to the bound framebuffer

◆ weave() [2/2]

void SR::DX11WeaverBase::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.

Parameters

width	of the image to be rendered to the bound framebuffer
height	of the image to be rendered to the bound framebuffer
xOffset	of the image to be rendered to the bound framebuffer
yOffset	of the image to be rendered to the bound framebuffer

Member Data Documentation

◆ pimpl

std::unique_ptr<Impl> SR::DX11WeaverBase::pimpl

protected

Suppressing warning because if we don't want to export everything then solving the underlying problem requires modification of the API Warning Description: 'type' : class 'type1' needs to have dll-interface to be used by clients of class 'type2' Candidate for deprecation

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

dx11weaver.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DX11WeaverBase()

◆ ~DX11WeaverBase()

Member Function Documentation

◆ canWeave() [1/3]

◆ canWeave() [2/3]

◆ canWeave() [3/3]

◆ enableLateLatching()

◆ getACTMode()

◆ getContrast()

◆ getCrosstalkDynamicFactor()

◆ getCrosstalkStaticFactor()

◆ getFrameBuffer()

◆ isLateLatchingEnabled()

◆ setACTMode()

◆ setContext()

◆ setContrast()

◆ setCrosstalkDynamicFactor()

◆ setCrosstalkStaticFactor()

◆ setInputFrameBuffer()

◆ setShaderSRGBConversion()

◆ setWindowHandle()

◆ weave() [1/2]

◆ weave() [2/2]

Member Data Documentation

◆ pimpl