Class that represents the default MacOS graphics output. More...

#include <kanzi/platform/platform/graphics_output/macos/default_macos_graphics_output.hpp>

Inheritance diagram for kanzi::macos::DefaultMacosGraphicsOutput:

Public Member Functions
bool	bringToFront () noexcept override
	WindowedGraphicsOutput::bringToFront() implementation.

	DefaultMacosGraphicsOutput (const DefaultMacosGraphicsOutput &)=delete
	Delete copy and move constructors and operators.

	DefaultMacosGraphicsOutput (const DefaultMacosGraphicsOutputProperties &properties)
	Constructor.

	DefaultMacosGraphicsOutput (DefaultMacosGraphicsOutput &&) noexcept=delete

void	gatherEvents (EventQueue &queue) override
	EventSource::gatherEvents() implementation.

KZ_NO_DISCARD EventQueue &	getEventQueue () noexcept
	Get the internal event queue.

KZ_NO_DISCARD optional< NativeEventHandle >	getNativeEventHandle () const noexcept override
	WakeupSignalSource::getNativeEventHandle() implementation.

KZ_NO_DISCARD uintptr_t	getNativeFramebufferHandle (platform::APIBackend backend) const noexcept override
	FramebufferGraphicsOutput::getNativeFramebufferHandle() implementation.

KZ_NO_DISCARD optional< NativeWindowHandle >	getNativeWindowHandle () const noexcept override
	WindowedGraphicsOutput::getNativeWindowHandle() implementation.

KZ_NO_DISCARD Matrix4x4	getTargetTransformation () const noexcept override
	FramebufferGraphicsOutput::getTargetTransformation() implementation.

KZ_NO_DISCARD optional< unsigned int >	getWindowHeight () const noexcept override
	WindowedGraphicsOutput::getWindowHeight() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionX () const noexcept override
	WindowedGraphicsOutput::getWindowPositionX() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionY () const noexcept override
	WindowedGraphicsOutput::getWindowPositionY() implementation.

KZ_NO_DISCARD optional< string >	getWindowTitle () const noexcept override
	WindowedGraphicsOutput::getWindowTitle() implementation.

KZ_NO_DISCARD optional< unsigned int >	getWindowWidth () const noexcept override
	WindowedGraphicsOutput::getWindowWidth() implementation.

bool	hideWindow () noexcept override
	WindowedGraphicsOutput::hideWindow() implementation.

bool	makeFullscreen () noexcept override
	WindowedGraphicsOutput::makeFullscreen() implementation.

bool	makeMaximized () noexcept override
	WindowedGraphicsOutput::makeMaximized() implementation.

bool	makeMinimized () noexcept override
	WindowedGraphicsOutput::makeMinimized() implementation.

bool	makeRegular () noexcept override
	WindowedGraphicsOutput::makeRegular() implementation.

bool	moveWindow (int positionX, int positionY) noexcept override
	WindowedGraphicsOutput::moveWindow() implementation.

DefaultMacosGraphicsOutput &	operator= (const DefaultMacosGraphicsOutput &)=delete

DefaultMacosGraphicsOutput &	operator= (DefaultMacosGraphicsOutput &&) noexcept=delete

void	perFrameCallback ()
	Called by Objective-C++ code to pass per frame signal from view.

void	registerFrameCallback (function< void()> callback)
	Registers a frame callback to call each frame.

bool	resize (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resize() implementation.

bool	resizeWindow (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resizeWindow() implementation.

bool	setWindowTitle (string_view title) noexcept override
	WindowedGraphicsOutput::setWindowTitle() implementation.

bool	showWindow () noexcept override
	WindowedGraphicsOutput::showWindow() implementation.

	~DefaultMacosGraphicsOutput () override
	Destructor.

Public Member Functions inherited from kanzi::GraphicsOutput
KZ_NO_DISCARD Vector2	getDpi () const noexcept
	Returns the resolution of the target coordinate system in dots per inch.

KZ_NO_DISCARD unsigned int	getHeight () const noexcept
	Returns the height of layout area in the target coordinate system.

KZ_NO_DISCARD unsigned int	getWidth () const noexcept
	Returns the width of layout area in the target coordinate system.

virtual	~GraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::EventSource
virtual	~EventSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::WakeupSignalSource
WakeupSignalSource &	operator= (const WakeupSignalSource &)=default
	Copy assignment operator.

WakeupSignalSource &	operator= (WakeupSignalSource &&) noexcept=default
	Move assignment operator.

	WakeupSignalSource ()=default
	Constructor.

	WakeupSignalSource (const WakeupSignalSource &)=default
	Copy constructor.

	WakeupSignalSource (WakeupSignalSource &&) noexcept=default
	Move constructor.

virtual	~WakeupSignalSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::FramebufferGraphicsOutput
	FramebufferGraphicsOutput () noexcept
	Constructor.

template<typename FramebufferT , typename = enable_if_t<is_base_of_v<FramebufferBase, FramebufferT>>>
KZ_NO_DISCARD FramebufferT *	getFramebuffer () const noexcept
	Returns the framebuffer for the graphics output.

template<typename FramebufferT , typename >
FramebufferT *	getFramebuffer () const noexcept

void	invalidate () noexcept
	Invalidates underlying framebuffer.

void	setFramebuffer (unique_ptr< FramebufferBase > framebuffer) noexcept
	Sets framebuffer for the graphics output.

virtual	~FramebufferGraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::WindowedGraphicsOutput
virtual	~WindowedGraphicsOutput ()=default
	Destructor.

Protected Member Functions
void	updateCache (uint32_t width, uint32_t height)
	Updates the target layout area size.

Protected Member Functions inherited from kanzi::GraphicsOutput
void	updateDpi (Vector2 dpi)
	Updates the target layout area resolution.

void	updateSize (unsigned int width, unsigned int height)
	Updates the target layout area size.

Detailed Description

Class that represents the default MacOS graphics output.

Since: Kanzi 4.0.0

Constructor & Destructor Documentation

◆ DefaultMacosGraphicsOutput() [1/3]

kanzi::macos::DefaultMacosGraphicsOutput::DefaultMacosGraphicsOutput ( const DefaultMacosGraphicsOutputProperties & properties )

explicit

Constructor.

Parameters

properties Specifies properties to request for the graphics output.

◆ ~DefaultMacosGraphicsOutput()

kanzi::macos::DefaultMacosGraphicsOutput::~DefaultMacosGraphicsOutput ( )

override

Destructor.

◆ DefaultMacosGraphicsOutput() [2/3]

kanzi::macos::DefaultMacosGraphicsOutput::DefaultMacosGraphicsOutput ( const DefaultMacosGraphicsOutput & )

delete

Delete copy and move constructors and operators.

◆ DefaultMacosGraphicsOutput() [3/3]

kanzi::macos::DefaultMacosGraphicsOutput::DefaultMacosGraphicsOutput ( DefaultMacosGraphicsOutput && )

deletenoexcept

Member Function Documentation

◆ gatherEvents()

void kanzi::macos::DefaultMacosGraphicsOutput::gatherEvents ( EventQueue & queue )

overridevirtual

EventSource::gatherEvents() implementation.

Implements kanzi::EventSource.

◆ getNativeEventHandle()

KZ_NO_DISCARD optional< NativeEventHandle > kanzi::macos::DefaultMacosGraphicsOutput::getNativeEventHandle ( ) const

overridevirtualnoexcept

WakeupSignalSource::getNativeEventHandle() implementation.

Implements kanzi::WakeupSignalSource.

◆ getTargetTransformation()

KZ_NO_DISCARD Matrix4x4 kanzi::macos::DefaultMacosGraphicsOutput::getTargetTransformation ( ) const

overridevirtualnoexcept

FramebufferGraphicsOutput::getTargetTransformation() implementation.

Implements kanzi::FramebufferGraphicsOutput.

◆ resize()

bool kanzi::macos::DefaultMacosGraphicsOutput::resize	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resize() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ setWindowTitle()

bool kanzi::macos::DefaultMacosGraphicsOutput::setWindowTitle ( string_view title )

overridevirtualnoexcept

WindowedGraphicsOutput::setWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowTitle()

KZ_NO_DISCARD optional< string > kanzi::macos::DefaultMacosGraphicsOutput::getWindowTitle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ resizeWindow()

bool kanzi::macos::DefaultMacosGraphicsOutput::resizeWindow	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resizeWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowWidth()

KZ_NO_DISCARD optional< unsigned int > kanzi::macos::DefaultMacosGraphicsOutput::getWindowWidth ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowWidth() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowHeight()

KZ_NO_DISCARD optional< unsigned int > kanzi::macos::DefaultMacosGraphicsOutput::getWindowHeight ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowHeight() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ moveWindow()

bool kanzi::macos::DefaultMacosGraphicsOutput::moveWindow	(	int	positionX,
		int	positionY )

overridevirtualnoexcept

WindowedGraphicsOutput::moveWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionX()

KZ_NO_DISCARD optional< int > kanzi::macos::DefaultMacosGraphicsOutput::getWindowPositionX ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionX() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionY()

KZ_NO_DISCARD optional< int > kanzi::macos::DefaultMacosGraphicsOutput::getWindowPositionY ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionY() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeFullscreen()

bool kanzi::macos::DefaultMacosGraphicsOutput::makeFullscreen ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeFullscreen() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeRegular()

bool kanzi::macos::DefaultMacosGraphicsOutput::makeRegular ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeRegular() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMaximized()

bool kanzi::macos::DefaultMacosGraphicsOutput::makeMaximized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMaximized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMinimized()

bool kanzi::macos::DefaultMacosGraphicsOutput::makeMinimized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMinimized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ showWindow()

bool kanzi::macos::DefaultMacosGraphicsOutput::showWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::showWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ hideWindow()

bool kanzi::macos::DefaultMacosGraphicsOutput::hideWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::hideWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ bringToFront()

bool kanzi::macos::DefaultMacosGraphicsOutput::bringToFront ( )

overridevirtualnoexcept

WindowedGraphicsOutput::bringToFront() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getNativeWindowHandle()

KZ_NO_DISCARD optional< NativeWindowHandle > kanzi::macos::DefaultMacosGraphicsOutput::getNativeWindowHandle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getNativeWindowHandle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getNativeFramebufferHandle()

KZ_NO_DISCARD uintptr_t kanzi::macos::DefaultMacosGraphicsOutput::getNativeFramebufferHandle ( platform::APIBackend backend ) const

overridevirtualnoexcept

FramebufferGraphicsOutput::getNativeFramebufferHandle() implementation.

Implements kanzi::FramebufferGraphicsOutput.

◆ registerFrameCallback()

void kanzi::macos::DefaultMacosGraphicsOutput::registerFrameCallback ( function< void()> callback )

Registers a frame callback to call each frame.

Used from Objective-C++ code to register frame callback to run Kanzi main loop.

Parameters

callback Callback function to call each frame.

◆ getEventQueue()

KZ_NO_DISCARD EventQueue & kanzi::macos::DefaultMacosGraphicsOutput::getEventQueue ( )

inlinenoexcept

Get the internal event queue.

Used internally from Objective-C++ code to add input events.

Returns: Event qeueue

◆ perFrameCallback()

void kanzi::macos::DefaultMacosGraphicsOutput::perFrameCallback ( )

Called by Objective-C++ code to pass per frame signal from view.

◆ operator=() [1/2]

DefaultMacosGraphicsOutput & kanzi::macos::DefaultMacosGraphicsOutput::operator= ( const DefaultMacosGraphicsOutput & )

delete

◆ operator=() [2/2]

DefaultMacosGraphicsOutput & kanzi::macos::DefaultMacosGraphicsOutput::operator= ( DefaultMacosGraphicsOutput && )

deletenoexcept

◆ updateCache()

void kanzi::macos::DefaultMacosGraphicsOutput::updateCache	(	uint32_t	width,
		uint32_t	height )

protected

Updates the target layout area size.

Parameters

width	The layout width in pixels.
height	The layout height in pixels.

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

kanzi/platform/platform/graphics_output/macos/default_macos_graphics_output.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DefaultMacosGraphicsOutput() [1/3]

◆ ~DefaultMacosGraphicsOutput()

◆ DefaultMacosGraphicsOutput() [2/3]

◆ DefaultMacosGraphicsOutput() [3/3]

Member Function Documentation

◆ gatherEvents()

◆ getNativeEventHandle()

◆ getTargetTransformation()

◆ resize()

◆ setWindowTitle()

◆ getWindowTitle()

◆ resizeWindow()

◆ getWindowWidth()

◆ getWindowHeight()

◆ moveWindow()

◆ getWindowPositionX()

◆ getWindowPositionY()

◆ makeFullscreen()

◆ makeRegular()

◆ makeMaximized()

◆ makeMinimized()

◆ showWindow()

◆ hideWindow()

◆ bringToFront()

◆ getNativeWindowHandle()

◆ getNativeFramebufferHandle()

◆ registerFrameCallback()

◆ getEventQueue()

◆ perFrameCallback()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ updateCache()