HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MaterialX::WindowWrapper Class Reference

#include <WindowWrapper.h>

Public Member Functions

virtual ~WindowWrapper ()
 
ExternalWindowHandle externalHandle () const
 Return "external" handle. More...
 
InternalWindowHandle internalHandle () const
 Return "internal" handle. More...
 
bool isValid () const
 
void release ()
 Release resources stored in wrapper. More...
 

Static Public Member Functions

static WindowWrapperPtr create (ExternalWindowHandle externalHandle={}, InternalWindowHandle internalHandle={}, DisplayHandle display={})
 Create a new WindowWrapper. More...
 

Protected Member Functions

 WindowWrapper (ExternalWindowHandle externalHandle, InternalWindowHandle internalHandle, DisplayHandle display)
 

Protected Attributes

ExternalWindowHandle _externalHandle
 
InternalWindowHandle _internalHandle
 

Detailed Description

Generic wrapper for encapsulating a "window" construct

Each supported platform will have specific storage and management logic.

Definition at line 60 of file WindowWrapper.h.

Constructor & Destructor Documentation

virtual MaterialX::WindowWrapper::~WindowWrapper ( )
virtual
MaterialX::WindowWrapper::WindowWrapper ( ExternalWindowHandle  externalHandle,
InternalWindowHandle  internalHandle,
DisplayHandle  display 
)
protected

Member Function Documentation

static WindowWrapperPtr MaterialX::WindowWrapper::create ( ExternalWindowHandle  externalHandle = {},
InternalWindowHandle  internalHandle = {},
DisplayHandle  display = {} 
)
static

Create a new WindowWrapper.

ExternalWindowHandle MaterialX::WindowWrapper::externalHandle ( ) const
inline

Return "external" handle.

Definition at line 72 of file WindowWrapper.h.

InternalWindowHandle MaterialX::WindowWrapper::internalHandle ( ) const
inline

Return "internal" handle.

Definition at line 78 of file WindowWrapper.h.

bool MaterialX::WindowWrapper::isValid ( ) const
inline

Check that there is a valid OS handle set. It is sufficient to just check the internal handle.

Definition at line 85 of file WindowWrapper.h.

void MaterialX::WindowWrapper::release ( )

Release resources stored in wrapper.

Member Data Documentation

ExternalWindowHandle MaterialX::WindowWrapper::_externalHandle
protected

Definition at line 107 of file WindowWrapper.h.

InternalWindowHandle MaterialX::WindowWrapper::_internalHandle
protected

Definition at line 108 of file WindowWrapper.h.


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