Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::DrawWindowEvent Class Reference

The DrawWindowEvent class is the event generated when the driver draws the window background for each subwindow. More...

#include <hps.h>

Inheritance diagram for HPS::DrawWindowEvent:
Collaboration diagram for HPS::DrawWindowEvent:

Public Types

enum  BackgroundTextureFormat {
  BackgroundTextureFormat::RGBA,
  BackgroundTextureFormat::BGRA,
  BackgroundTextureFormat::ImageExternal,
  BackgroundTextureFormat::LumaChromaPair
}
 Enumerates the various texture formats supported by the DrawTexturedBackground function . More...
 
enum  StereoMatrix {
  StereoMatrix::ViewLeft,
  StereoMatrix::ViewRight,
  StereoMatrix::ProjectionLeft,
  StereoMatrix::ProjectionRight
}
 

Public Member Functions

 DrawWindowEvent (OpaqueHandle in_nr=0)
 
virtual ~DrawWindowEvent ()
 The screen extent for the window being drawn. More...
 
void DrawTexturedBackground (OpaqueHandle in_texture, BackgroundTextureFormat in_format, MatrixKit const &in_matrix, IntRectangle const &in_extent) const
 Function for drawing a platform-specific texture in place of the normal window background. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
void SetStereoMatrix (StereoMatrix id, HPS::MatrixKit const &in_matrix) const
 
OpaqueHandle GetSurface (int index) const
 
OpaqueHandle GetGraphicsContext () const
 

Public Attributes

IntRectangle Extent
 

Protected Attributes

OpaqueHandle nr
 

Private Attributes

HPS::FloatArray matrix_elements
 

Detailed Description

The DrawWindowEvent class is the event generated when the driver draws the window background for each subwindow.

Member Enumeration Documentation

◆ BackgroundTextureFormat

Enumerates the various texture formats supported by the DrawTexturedBackground function .

Enumerator
RGBA 

Handle to single GL_RGBA format texture.

BGRA 

Same as RGBA but with swapped red and blue channels.

ImageExternal 

Handle to single OES_EGL_image_external texture.

LumaChromaPair 

Pointer to array of two GL texture handles for YpCbCr texture pair (GL_LUMINANCE, GL_LUMINANCE_ALPHA formats).

◆ StereoMatrix

enum HPS::DriverEvent::StereoMatrix
stronginherited
Enumerator
ViewLeft 
ViewRight 
ProjectionLeft 
ProjectionRight 

Constructor & Destructor Documentation

◆ DrawWindowEvent()

HPS::DrawWindowEvent::DrawWindowEvent ( OpaqueHandle  in_nr = 0)

◆ ~DrawWindowEvent()

virtual HPS::DrawWindowEvent::~DrawWindowEvent ( )
virtual

The screen extent for the window being drawn.

Member Function Documentation

◆ DrawTexturedBackground()

void HPS::DrawWindowEvent::DrawTexturedBackground ( OpaqueHandle  in_texture,
BackgroundTextureFormat  in_format,
MatrixKit const &  in_matrix,
IntRectangle const &  in_extent 
) const

Function for drawing a platform-specific texture in place of the normal window background.

Parameters
in_textureThe platform-specific texture handle(s)
in_formatThe format of the texture(s) provided through the 'in_texture' parameter.
in_matrixA transformation to apply to the uv coordinates used to draw the texture to the window.
in_extentThe screen extent for the window background to be drawn.

◆ GetClassID()

intptr_t HPS::DriverEvent::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

◆ GetGraphicsContext()

OpaqueHandle HPS::DriverEvent::GetGraphicsContext ( ) const
inherited

◆ GetSurface()

OpaqueHandle HPS::DriverEvent::GetSurface ( int  index) const
inherited

◆ SetStereoMatrix()

void HPS::DriverEvent::SetStereoMatrix ( StereoMatrix  id,
HPS::MatrixKit const &  in_matrix 
) const
inherited

Member Data Documentation

◆ Extent

IntRectangle HPS::DrawWindowEvent::Extent

◆ matrix_elements

HPS::FloatArray HPS::DrawWindowEvent::matrix_elements
mutableprivate

◆ nr

OpaqueHandle HPS::DriverEvent::nr
protectedinherited

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