The Nebula Device 3: Graphics::Display Class Reference

The Nebula Device 3

Graphics::Display Class Reference

#include <display.h>

Inheritance diagram for Graphics::Display:

Core::RefCounted

Detailed Description

The Display object is used to access DisplayDevice functionality from a different thread. Usually only the main thread creates a display object.

(C) 2008 Radon Labs GmbH

Public Member Functions

 Display ()
 constructor
virtual ~Display ()
 destructor
DisplaySettingsSettings ()
 access to display settings
void SetParentWindow (void *h)
 set optional parent window handle (a HWND if running under windows)
void * GetParentWindow () const
 get optional parent window handle
void SetResourceMappers (const Util::Array< Ptr< Resources::ResourceMapper > > &resourceMappers)
 set resource mappers (NOTE: there is not Getter for this to prevent messing around with render-thread objects!)
void Open ()
 open the display (waits for completion)
void Close ()
 close the display (waits for completion)
bool IsOpen () const
 return true if display is currently open
bool AdapterExists (CoreGraphics::Adapter::Code adapter)
 return true if adapter exists (waits for completion)
Util::Array< CoreGraphics::DisplayModeGetAvailableDisplayModes (CoreGraphics::Adapter::Code adapter, CoreGraphics::PixelFormat::Code pixelFormat)
 get available display modes on given adapter (waits for completion)
bool SupportsDisplayMode (CoreGraphics::Adapter::Code adapter, const CoreGraphics::DisplayMode &requestedMode)
 return true if a given display mode is supported (waits for completion)
CoreGraphics::DisplayMode GetCurrentAdapterDisplayMode (CoreGraphics::Adapter::Code adapter)
 get current adapter display mode (i.e. the desktop display mode) (waits for completion)
CoreGraphics::AdapterInfo GetAdapterInfo (CoreGraphics::Adapter::Code adapter)
 get general info about display adapter (waits for completion)
void AttachDisplayEventHandler (const Ptr< CoreGraphics::ThreadSafeDisplayEventHandler > &displayEventHandler)
 attach a display event handler
void RemoveDisplayEventHandler (const Ptr< CoreGraphics::ThreadSafeDisplayEventHandler > &displayEventHandler)
 remove a display event handler
void AttachRenderEventHandler (const Ptr< CoreGraphics::ThreadSafeRenderEventHandler > &renderEventHandler)
 attach a render event handler
void RemoveRenderEventHandler (const Ptr< CoreGraphics::ThreadSafeRenderEventHandler > &renderEventHandler)
 remove a render event handler
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.