The IView video object interface. More...

#include "murl_video_i_view.h"

Inherited by Murl::Video::View.

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Video::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Video::IObject interface. More...
 
virtual Bool Enable ()=0
 Enable the view. More...
 
virtual Bool Disable ()=0
 Disable the view. More...
 
virtual Bool Set (IProgram *currentProgram)=0
 Attach the view to the current GPU program. More...
 
virtual Bool SetDepthOrder (SInt32 depthOrder)=0
 Set the view's absolute depth order. More...
 
virtual SInt32 GetDepthOrder () const =0
 Get the view's absolute depth order. More...
 
virtual Bool SetMask (SInt32 x1, SInt32 x2, SInt32 y1, SInt32 y2)=0
 Set the view mask. More...
 
virtual SInt32 GetMaskX1 () const =0
 Get the view mask's left border coordinate. More...
 
virtual SInt32 GetMaskX2 () const =0
 Get the view mask's right border coordinate. More...
 
virtual SInt32 GetMaskY1 () const =0
 Get the view mask's bottom border coordinate. More...
 
virtual SInt32 GetMaskY2 () const =0
 Get the view mask's top border coordinate. More...
 
virtual Bool SetFrameBuffer (IFrameBuffer *frameBuffer)=0
 Set the view frame buffer. More...
 
virtual IFrameBufferGetFrameBuffer () const =0
 Get the view frame buffer. More...
 

Detailed Description

The IView video object interface.

This interface represents a viewport used for rendering a scene.

Used internally by Graph::View.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Video::IView::GetObjectInterface ( )
pure virtual

Get the mutable Video::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Video::IView::GetObjectInterface ( ) const
pure virtual

Get the constant Video::IObject interface.

Returns
The IObject interface.

◆ Enable()

virtual Bool Murl::Video::IView::Enable ( )
pure virtual

Enable the view.

Returns
true if successful.

◆ Disable()

virtual Bool Murl::Video::IView::Disable ( )
pure virtual

Disable the view.

Returns
true if successful.

◆ Set()

virtual Bool Murl::Video::IView::Set ( IProgram currentProgram)
pure virtual

Attach the view to the current GPU program.

Parameters
currentProgramThe current GPU program.
Returns
true if successful.

◆ SetDepthOrder()

virtual Bool Murl::Video::IView::SetDepthOrder ( SInt32  depthOrder)
pure virtual

Set the view's absolute depth order.

Parameters
depthOrderThe absolute order of this view within its render target.
Returns
true if successful.

◆ GetDepthOrder()

virtual SInt32 Murl::Video::IView::GetDepthOrder ( ) const
pure virtual

Get the view's absolute depth order.

Returns
The absolute order of this view within its render target.

◆ SetMask()

virtual Bool Murl::Video::IView::SetMask ( SInt32  x1,
SInt32  x2,
SInt32  y1,
SInt32  y2 
)
pure virtual

Set the view mask.

Parameters
x1The left mask coordinate in pixels.
y1The bottom mask coordinate in pixels.
x2The right mask coordinate in pixels.
y2The top mask coordinate in pixels.
Returns
true if successful.

◆ GetMaskX1()

virtual SInt32 Murl::Video::IView::GetMaskX1 ( ) const
pure virtual

Get the view mask's left border coordinate.

Returns
The left mask coordinate in pixels.

◆ GetMaskX2()

virtual SInt32 Murl::Video::IView::GetMaskX2 ( ) const
pure virtual

Get the view mask's right border coordinate.

Returns
The right mask coordinate in pixels.

◆ GetMaskY1()

virtual SInt32 Murl::Video::IView::GetMaskY1 ( ) const
pure virtual

Get the view mask's bottom border coordinate.

Returns
The bottom mask coordinate in pixels.

◆ GetMaskY2()

virtual SInt32 Murl::Video::IView::GetMaskY2 ( ) const
pure virtual

Get the view mask's top border coordinate.

Returns
The top mask coordinate in pixels.

◆ SetFrameBuffer()

virtual Bool Murl::Video::IView::SetFrameBuffer ( IFrameBuffer frameBuffer)
pure virtual

Set the view frame buffer.

Parameters
frameBufferThe frame buffer to use, or null if rendering to the back buffer.
Returns
true if successful.

◆ GetFrameBuffer()

virtual IFrameBuffer* Murl::Video::IView::GetFrameBuffer ( ) const
pure virtual

Get the view frame buffer.

Returns
The frame buffer used, or null if rendering to the back buffer.

The documentation for this interface was generated from the following file:
  • murl_video_i_view.h


Copyright © 2011-2018 Spraylight GmbH.