SDL::MetalView Struct Reference

A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS). More...

Inheritance diagram for SDL::MetalView:

Public Member Functions
constexpr	MetalView (MetalViewRaw resource) noexcept
	Constructs from raw MetalView.
constexpr	MetalView (MetalView &&other) noexcept
	Move constructor.
	MetalView (WindowRef window)
	Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window.
	~MetalView ()
	Destructor.
constexpr MetalView &	operator= (MetalView &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::MetalViewBase
void	Destroy ()
	Destroy an existing MetalView object.
void *	GetLayer ()
	Get a pointer to the backing CAMetalLayer for the given view.
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	ResourceBaseT (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBaseT (std::nullptr_t)
	Constructs null/invalid.
constexpr	ResourceBaseT (const ResourceBaseT &)=default
	Copy constructor.
constexpr	ResourceBaseT (ResourceBaseT &&) noexcept=default
	Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< MetalViewRaw >
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBaseT &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBaseT< MetalViewRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< MetalViewRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).

Since

This datatype is available since SDL 3.2.0.

Category:

Resource

Constructor & Destructor Documentation

MetalView()

SDL::MetalView::MetalView ( MetalViewRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw MetalView.

Parameters

resource

a MetalViewRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

---

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

• SDL3pp/SDL3pp_metal.h