Vulkan::VkDisplayDevice Class Reference

#include <vkdisplaydevice.h>

Inherits GLFW::GLFWDisplayDevice.

Public Member Functions
	VkDisplayDevice ()
	constructor
virtual	~VkDisplayDevice ()
	destructor
Public Member Functions inherited from GLFW::GLFWDisplayDevice
	GLFWDisplayDevice ()
	constructor
virtual	~GLFWDisplayDevice ()
	destructor
bool	Open ()
	open the display
void	Close ()
	close the display
bool	AdapterExists (CoreGraphics::Adapter::Code adapter)
	return true if adapter exists
Util::Array< CoreGraphics::DisplayMode >	GetAvailableDisplayModes (CoreGraphics::Adapter::Code adapter, CoreGraphics::PixelFormat::Code pixelFormat)
	get available display modes on given adapter
bool	SupportsDisplayMode (CoreGraphics::Adapter::Code adapter, const CoreGraphics::DisplayMode &requestedMode)
	return true if a given display mode is supported
CoreGraphics::DisplayMode	GetCurrentAdapterDisplayMode (CoreGraphics::Adapter::Code adapter)
	get current adapter display mode (i.e. the desktop display mode)
CoreGraphics::AdapterInfo	GetAdapterInfo (CoreGraphics::Adapter::Code adapter)
	get general info about display adapter
Public Member Functions inherited from Base::DisplayDeviceBase
	DisplayDeviceBase ()
	constructor
virtual	~DisplayDeviceBase ()
	destructor
bool	Open ()
	open the display
void	Close ()
	close the display
bool	IsOpen () const
	return true if display is currently open
void	ProcessWindowMessages ()
	process window system messages, call this method once per frame
void	Reopen ()
	reopens the display device which enables switching from display modes
void	SetVerticalSyncEnabled (bool b)
	set if vertical sync should be used
const bool	IsVerticalSyncEnabled () const
	get if vertical sync is enabled
bool	AdapterExists (CoreGraphics::Adapter::Code adapter)
	return true if adapter exists
Util::Array< CoreGraphics::DisplayMode >	GetAvailableDisplayModes (CoreGraphics::Adapter::Code adapter, CoreGraphics::PixelFormat::Code pixelFormat)
	get available display modes on given adapter
bool	SupportsDisplayMode (CoreGraphics::Adapter::Code adapter, const CoreGraphics::DisplayMode &requestedMode)
	return true if a given display mode is supported
CoreGraphics::DisplayMode	GetCurrentAdapterDisplayMode (CoreGraphics::Adapter::Code adapter)
	get current adapter display mode (i.e. the desktop display mode)
CoreGraphics::AdapterInfo	GetAdapterInfo (CoreGraphics::Adapter::Code adapter)
	get general info about display adapter
void	SetAdapter (CoreGraphics::Adapter::Code a)
	set display adapter (make sure adapter exists!)
CoreGraphics::Adapter::Code	GetAdapter () const
	get display adapter
const bool	IsFullscreen () const
	get if a window is running in full screen
void	AttachEventHandler (const Ptr< CoreGraphics::DisplayEventHandler > &h)
	attach a display event handler
void	RemoveEventHandler (const Ptr< CoreGraphics::DisplayEventHandler > &h)
	remove a display event handler
CoreGraphics::WindowId	SetupWindow (const Util::String &title, const Util::String &icon, const CoreGraphics::DisplayMode &displayMode, const CoreGraphics::AntiAliasQuality::Code aa=CoreGraphics::AntiAliasQuality::None)
	create a new window
CoreGraphics::WindowId	EmbedWindow (const Util::Blob &windowData)
	create a window from one created by another window system
CoreGraphics::WindowId	GetMainWindow () const
	get the 'main' window, if none exists, returns NULL
const CoreGraphics::WindowId	GetCurrentWindow () const
	get the current window
const CoreGraphics::WindowId	GetWindow (IndexT index) const
	get window using index, where 0 is the default window
const Util::Array< CoreGraphics::WindowId > &	GetWindows () const
	get all windows as an array
void	MakeWindowCurrent (const CoreGraphics::WindowId id)
	make ID the current one
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
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::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (VkDisplayDevice)
	__DeclareSingleton (VkDisplayDevice)
bool	WindowOpen ()
	open window
bool	EmbedWindow ()
	open embedded window
void	SetupSwapchain ()
	setup swapchain

Private Attributes
VkSurfaceKHR	surface

Friends
class	VkRenderDevice

Additional Inherited Members
Static Public Member Functions inherited from GLFW::GLFWDisplayDevice
static void	ProcessWindowMessages ()
	process window system messages, call this method once per frame
static Input::Key::Code	TranslateKeyCode (int inkey)
	translate glfw keycodes to nebula ones
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from GLFW::GLFWDisplayDevice
GLFWmonitor *	GetMonitor (int index)
	retrieve monitor from adapter. can be NULL
Protected Member Functions inherited from Base::DisplayDeviceBase
bool	NotifyEventHandlers (const CoreGraphics::DisplayEvent &e)
	notify event handlers about an event
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)
Protected Attributes inherited from GLFW::GLFWDisplayDevice
Ptr< GLFWInputDisplayEventHandler >	inputEventHandler
Ptr< GLFWGraphicsDisplayEventHandler >	graphicsEventHandler
Protected Attributes inherited from Base::DisplayDeviceBase
CoreGraphics::Adapter::Code	adapter
bool	verticalSync
bool	isOpen
bool	isFullscreen
Util::Array< Ptr< CoreGraphics::DisplayEventHandler > >	eventHandlers
CoreGraphics::WindowId	currentWindow
Util::Array< CoreGraphics::WindowId >	windows

Constructor & Destructor Documentation

VkDisplayDevice()

Vulkan::VkDisplayDevice::VkDisplayDevice

(

)

constructor

~VkDisplayDevice()

Vulkan::VkDisplayDevice::~VkDisplayDevice ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Vulkan::VkDisplayDevice::__DeclareClass ( VkDisplayDevice )

private

__DeclareSingleton()

Vulkan::VkDisplayDevice::__DeclareSingleton ( VkDisplayDevice )

private

EmbedWindow()

bool Vulkan::VkDisplayDevice::EmbedWindow ( )

private

open embedded window

SetupSwapchain()

void Vulkan::VkDisplayDevice::SetupSwapchain ( )

private

setup swapchain

WindowOpen()

bool Vulkan::VkDisplayDevice::WindowOpen ( )

private

open window

Friends And Related Symbol Documentation

VkRenderDevice

friend class VkRenderDevice

friend

Member Data Documentation

surface

VkSurfaceKHR Vulkan::VkDisplayDevice::surface

private

---

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

• /github/workspace/code/render/coregraphics/vk/vkdisplaydevice.h
• /github/workspace/code/render/coregraphics/vk/vkdisplaydevice.cc