Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Member Functions | Static Public Member Functions | List of all members
SR::GLWeaver Class Reference

#include <glweaver.h>

Inheritance diagram for SR::GLWeaver:
[legend]
Collaboration diagram for SR::GLWeaver:
[legend]

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 ()
 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...
 
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...
 

Static Public Member Functions

static GLWeavercreate (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()

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
contextto connect to
widthof the side-by-side image to be weaved together
heightof the side-by-side image to be weaved together
Exceptions
std::exceptionif 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
contextto connect to, needs to be valid for the lifetime of the weaver object.
widthof the side-by-side image to be weaved together
heightof the side-by-side image to be weaved together
Exceptions
std::exceptionif 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: