kanzi::ios::DefaultIosGraphicsOutput Class Reference

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

#include <kanzi/platform/platform/graphics_output/ios/default_ios_graphics_output.hpp>

Inheritance diagram for kanzi::ios::DefaultIosGraphicsOutput:

Public Member Functions
	DefaultIosGraphicsOutput (CALayer *layer)
	Constructor for embedded use with an externally-owned layer.
	DefaultIosGraphicsOutput (const DefaultIosGraphicsOutput &)=delete
	Delete copy and move constructors and operators.
	DefaultIosGraphicsOutput (DefaultIosGraphicsOutput &&) 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 Matrix4x4	getTargetTransformation () const noexcept override
	FramebufferGraphicsOutput::getTargetTransformation() implementation.
DefaultIosGraphicsOutput &	operator= (const DefaultIosGraphicsOutput &)=delete
DefaultIosGraphicsOutput &	operator= (DefaultIosGraphicsOutput &&) 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.
	~DefaultIosGraphicsOutput () 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.

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 iOS graphics output.

Since

Kanzi 4.0.0

Kanzi 4.1.0 changed Constructor now accepts a CALayer* pointer directly; DefaultIosGraphicsOutputProperties is removed.

Constructor & Destructor Documentation

DefaultIosGraphicsOutput() [1/3]

kanzi::ios::DefaultIosGraphicsOutput::DefaultIosGraphicsOutput ( CALayer * layer )

explicit

Constructor for embedded use with an externally-owned layer.

The layer must be a CAMetalLayer. Does not create UIWindow, UIView, or UIViewController.

Parameters

layer

The CAMetalLayer to use for rendering.

~DefaultIosGraphicsOutput()

kanzi::ios::DefaultIosGraphicsOutput::~DefaultIosGraphicsOutput ( )

override

Destructor.

DefaultIosGraphicsOutput() [2/3]

kanzi::ios::DefaultIosGraphicsOutput::DefaultIosGraphicsOutput ( const DefaultIosGraphicsOutput & )

delete

Delete copy and move constructors and operators.

DefaultIosGraphicsOutput() [3/3]

kanzi::ios::DefaultIosGraphicsOutput::DefaultIosGraphicsOutput ( DefaultIosGraphicsOutput && )

deletenoexcept

Member Function Documentation

gatherEvents()

void kanzi::ios::DefaultIosGraphicsOutput::gatherEvents ( EventQueue & queue )

overridevirtual

EventSource::gatherEvents() implementation.

Implements kanzi::EventSource.

getNativeEventHandle()

KZ_NO_DISCARD optional< NativeEventHandle > kanzi::ios::DefaultIosGraphicsOutput::getNativeEventHandle ( ) const

overridevirtualnoexcept

WakeupSignalSource::getNativeEventHandle() implementation.

Implements kanzi::WakeupSignalSource.

getTargetTransformation()

KZ_NO_DISCARD Matrix4x4 kanzi::ios::DefaultIosGraphicsOutput::getTargetTransformation ( ) const

overridevirtualnoexcept

FramebufferGraphicsOutput::getTargetTransformation() implementation.

Implements kanzi::FramebufferGraphicsOutput.

getNativeFramebufferHandle()

KZ_NO_DISCARD uintptr_t kanzi::ios::DefaultIosGraphicsOutput::getNativeFramebufferHandle ( platform::APIBackend backend ) const

overridevirtualnoexcept

FramebufferGraphicsOutput::getNativeFramebufferHandle() implementation.

Implements kanzi::FramebufferGraphicsOutput.

registerFrameCallback()

void kanzi::ios::DefaultIosGraphicsOutput::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::ios::DefaultIosGraphicsOutput::getEventQueue ( )

inlinenoexcept

Get the internal event queue.

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

Returns

Event queue.

perFrameCallback()

void kanzi::ios::DefaultIosGraphicsOutput::perFrameCallback

(

)

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

operator=() [1/2]

DefaultIosGraphicsOutput & kanzi::ios::DefaultIosGraphicsOutput::operator= ( const DefaultIosGraphicsOutput & )

delete

operator=() [2/2]

DefaultIosGraphicsOutput & kanzi::ios::DefaultIosGraphicsOutput::operator= ( DefaultIosGraphicsOutput && )

deletenoexcept

updateCache()

void kanzi::ios::DefaultIosGraphicsOutput::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/ios/default_ios_graphics_output.hpp