vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsgMacOS::MacOS_Window Class Reference

MacOS_Window implements macOS specific window creation, event handling and vulkan Surface setup. More...

#include <MacOS_Window.h>

Inheritance diagram for vsgMacOS::MacOS_Window:
Collaboration diagram for vsgMacOS::MacOS_Window:

Public Member Functions

 MacOS_Window (vsg::ref_ptr< vsg::WindowTraits > traits)
 MacOS_Window (const MacOS_Window &)=delete
MacOS_Window operator= (const MacOS_Window &)=delete
const char * instanceExtensionSurfaceName () const override
bool valid () const override
bool pollEvents (vsg::UIEvents &events) override
 get the list of events since the last pollEvents() call by splicing bufferEvents with polled windowing events.
void resize () override
bool handleNSEvent (NSEvent *anEvent)
vsg_MacOS_NSWindow * window ()
vsg_MacOS_NSView * view ()
CAMetalLayer * layer ()
vsg::clock::time_point getEventTime (double eventTime)
void queueEvent (vsg::UIEvent *anEvent)
Public Member Functions inherited from vsg::Inherit< vsg::Window, MacOS_Window >
 Inherit (Args &&... args)
std::size_t sizeofObject () const noexcept override
const char * className () const noexcept override
const std::type_info & type_info () const noexcept override
bool is_compatible (const std::type_info &type) const noexcept override
int compare (const Object &rhs) const override
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::Window
 Window (const Window &)=delete
Windowoperator= (const Window &)=delete
virtual bool visible () const
virtual void releaseWindow ()
virtual void releaseConnection ()
ref_ptr< WindowTraitstraits ()
const ref_ptr< WindowTraitstraits () const
const VkExtent2D & extent2D () const
vec4clearColor ()
const vec4clearColor () const
VkSurfaceFormatKHR surfaceFormat ()
VkFormat depthFormat ()
VkSampleCountFlagBits framebufferSamples () const
void setInstance (ref_ptr< Instance > instance)
ref_ptr< InstancegetInstance ()
ref_ptr< InstancegetOrCreateInstance ()
void setSurface (ref_ptr< Surface > surface)
ref_ptr< SurfacegetSurface ()
ref_ptr< SurfacegetOrCreateSurface ()
void setPhysicalDevice (ref_ptr< PhysicalDevice > physicalDevice)
ref_ptr< PhysicalDevicegetPhysicalDevice ()
ref_ptr< PhysicalDevicegetOrCreatePhysicalDevice ()
void setDevice (ref_ptr< Device > device)
ref_ptr< DevicegetDevice ()
ref_ptr< DevicegetOrCreateDevice ()
void setRenderPass (ref_ptr< RenderPass > renderPass)
ref_ptr< RenderPassgetRenderPass ()
ref_ptr< RenderPassgetOrCreateRenderPass ()
ref_ptr< SwapchaingetSwapchain ()
ref_ptr< SwapchaingetOrCreateSwapchain ()
ref_ptr< ImagegetDepthImage ()
ref_ptr< ImagegetOrCreateDepthImage ()
ref_ptr< ImageViewgetDepthImageView ()
ref_ptr< ImageViewgetOrCreateDepthImageView ()
size_t numFrames () const
ref_ptr< ImageViewimageView (size_t i)
const ref_ptr< ImageViewimageView (size_t i) const
ref_ptr< Framebufferframebuffer (size_t i)
const ref_ptr< Framebufferframebuffer (size_t i) const
VkResult acquireNextImage (uint64_t timeout=std::numeric_limits< uint64_t >::max())
 call vkAquireNextImageKHR to find the next imageIndex of the swapchain images/framebuffers
size_t imageIndex (size_t relativeFrameIndex=0) const
 get the image index for specified relative frame index, a 0 value is the current frame being rendered, 1 is the previous frame, 2 is the frame before that.
bool debugLayersEnabled () const
Frameframe (size_t i)
Frames & frames ()
Public Member Functions inherited from vsg::Inherit< Object, Window >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Objectclone (const CopyOp &copyop={}) const
virtual void traverse (Visitor &)
virtual void accept (ConstVisitor &visitor) const
virtual void traverse (ConstVisitor &) const
virtual void accept (RecordTraversal &visitor) const
virtual void traverse (RecordTraversal &) const
virtual void read (Input &input)
virtual void write (Output &output) const
void ref () const noexcept
void unref () const noexcept
void unref_nodelete () const noexcept
unsigned int referenceCount () const noexcept
template<typename T>
void setValue (const std::string &key, const T &value)
void setValue (const std::string &key, const char *value)
 specialization of setValue to handle passing C strings
template<typename T>
bool getValue (const std::string &key, T &value) const
 get specified value type, return false if value associated with key is not assigned or is not the correct type
void setObject (const std::string &key, ref_ptr< Object > object)
 assign an Object associated with key
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const ObjectgetObject (const std::string &key) const
 get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
T * getObject (const std::string &key)
 get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const T * getObject (const std::string &key) const
 get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< ObjectgetRefObject (const std::string &key)
 get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< const ObjectgetRefObject (const std::string &key) const
 get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
ref_ptr< T > getRefObject (const std::string &key)
 get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const ref_ptr< const T > getRefObject (const std::string &key) const
 get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
void removeObject (const std::string &key)
 remove meta object or value associated with key
AuxiliarygetOrCreateAuxiliary ()
AuxiliarygetAuxiliary ()
const AuxiliarygetAuxiliary () const

Protected Member Functions

void _initSurface () override
Protected Member Functions inherited from vsg::Window
 Window (ref_ptr< WindowTraits > traits)
void _initFormats ()
void _initInstance ()
void _initPhysicalDevice ()
void _initDevice ()
void _initRenderPass ()
void _initSwapchain ()
virtual void clear ()
void share (ref_ptr< Device > device)
void buildSwapchain ()
Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Protected Attributes

vsg_MacOS_NSWindow * _window
vsg_MacOS_NSView * _view
CAMetalLayer * _metalLayer
double _first_macos_timestamp = 0
vsg::clock::time_point _first_macos_time_point
vsg::ref_ptr< KeyboardMap_keyboard
Protected Attributes inherited from vsg::Window
ref_ptr< WindowTraits_traits
VkExtent2D _extent2D
vec4 _clearColor
VkSurfaceFormatKHR _imageFormat
VkFormat _depthFormat
VkSampleCountFlagBits _framebufferSamples
ref_ptr< Instance_instance
ref_ptr< PhysicalDevice_physicalDevice
ref_ptr< Device_device
ref_ptr< Surface_surface
ref_ptr< Swapchain_swapchain
ref_ptr< RenderPass_renderPass
ref_ptr< Image_depthImage
ref_ptr< ImageView_depthImageView
ref_ptr< Image_multisampleImage
ref_ptr< ImageView_multisampleImageView
ref_ptr< Image_multisampleDepthImage
ref_ptr< ImageView_multisampleDepthImageView
ref_ptr< Semaphore_availableSemaphore
Frames _frames
std::vector< size_t > _indices

Additional Inherited Members

Public Types inherited from vsg::Window
using Frames = std::vector<Frame>
Static Public Member Functions inherited from vsg::Inherit< vsg::Window, MacOS_Window >
static ref_ptr< MacOS_Window > create (Args &&... args)
static ref_ptr< MacOS_Window > create_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Window
static ref_ptr< Windowcreate (vsg::ref_ptr< WindowTraits > traits)
 static Window::create(traits) method creates a platform specific Window instance based on specified window traits.
Static Public Member Functions inherited from vsg::Inherit< Object, Window >
static ref_ptr< Windowcreate (Args &&... args)
static ref_ptr< Windowcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
static ref_ptr< Objectcreate_if (bool flag)
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
static void operator delete (void *ptr)
Public Attributes inherited from vsg::Window
UIEvents bufferedEvents
 events buffered since the last pollEvents.

Detailed Description

MacOS_Window implements macOS specific window creation, event handling and vulkan Surface setup.

Member Function Documentation

◆ _initSurface()

void vsgMacOS::MacOS_Window::_initSurface ( )
overrideprotectedvirtual

Implements vsg::Window.

◆ instanceExtensionSurfaceName()

const char * vsgMacOS::MacOS_Window::instanceExtensionSurfaceName ( ) const
inlineoverridevirtual

Implements vsg::Window.

◆ pollEvents()

bool vsgMacOS::MacOS_Window::pollEvents ( vsg::UIEvents & events)
overridevirtual

get the list of events since the last pollEvents() call by splicing bufferEvents with polled windowing events.

Reimplemented from vsg::Window.

◆ resize()

void vsgMacOS::MacOS_Window::resize ( )
overridevirtual

Reimplemented from vsg::Window.

◆ valid()

bool vsgMacOS::MacOS_Window::valid ( ) const
inlineoverridevirtual

Reimplemented from vsg::Window.


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