Urho3D::RenderSurface Class Reference

Color or depth-stencil surface that can be rendered into. More...

#include <OGLRenderSurface.h>

Inheritance diagram for Urho3D::RenderSurface:
Collaboration diagram for Urho3D::RenderSurface:

Public Member Functions

 RenderSurface (Texture *parentTexture)
 Construct with parent texture.
 ~RenderSurface ()
void SetNumViewports (unsigned num)
 Set number of viewports.
void SetViewport (unsigned index, Viewport *viewport)
 Set viewport.
void SetUpdateMode (RenderSurfaceUpdateMode mode)
 Set viewport update mode. Default is to update when visible.
void SetLinkedRenderTarget (RenderSurface *renderTarget)
 Set linked color rendertarget.
void SetLinkedDepthStencil (RenderSurface *depthStencil)
 Set linked depth-stencil surface.
void QueueUpdate ()
 Queue manual update of the viewport(s).
bool CreateRenderBuffer (unsigned width, unsigned height, unsigned format)
 Create a renderbuffer. Return true if successful.
void OnDeviceLost ()
 Handle device loss.
void Release ()
 Release renderbuffer if any.
TextureGetParentTexture () const
 Return parent texture.
unsigned GetRenderBuffer () const
 Return renderbuffer if created.
int GetWidth () const
 Return width.
int GetHeight () const
 Return height.
TextureUsage GetUsage () const
 Return usage.
unsigned GetNumViewports () const
 Return number of viewports.
ViewportGetViewport (unsigned index) const
 Return viewport by index.
RenderSurfaceUpdateMode GetUpdateMode () const
 Return viewport update mode.
RenderSurfaceGetLinkedRenderTarget () const
 Return linked color buffer.
RenderSurfaceGetLinkedDepthStencil () const
 Return linked depth buffer.
void SetTarget (unsigned target)
 Set surface's OpenGL target.
unsigned GetTarget () const
 Return surface's OpenGL target.
void WasUpdated ()
 Clear update flag. Called by Renderer.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int Refs () const
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Private Attributes

 Parent texture.
unsigned target_
 OpenGL target.
unsigned renderBuffer_
 OpenGL renderbuffer.
Vector< SharedPtr< Viewport > > viewports_
WeakPtr< RenderSurfacelinkedRenderTarget_
 Linked color buffer.
WeakPtr< RenderSurfacelinkedDepthStencil_
 Linked depth buffer.
RenderSurfaceUpdateMode updateMode_
 Update mode for viewports.
bool updateQueued_
 Update queued flag.


class Texture2D
class TextureCube

Detailed Description

Color or depth-stencil surface that can be rendered into.

The documentation for this class was generated from the following files:
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLRenderSurface.h
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLRenderSurface.cpp