SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
SDL::MetalView Struct Reference

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

Inheritance diagram for SDL::MetalView:
[legend]

Public Member Functions

constexpr MetalView (MetalViewRaw resource) noexcept
 Constructs from raw MetalView.
constexpr MetalView (const MetalView &other)=delete
 Copy constructor.
constexpr MetalView (MetalView &&other) noexcept
 Move constructor.
constexpr MetalView (const MetalViewRef &other)=delete
constexpr MetalView (MetalViewRef &&other)=delete
 MetalView (WindowRef window)
 Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window.
 ~MetalView ()
 Destructor.
constexpr MetalViewoperator= (MetalView &&other) noexcept
 Assignment operator.
MetalViewoperator= (const MetalView &other)=delete
 Assignment operator.
void Destroy ()
 Destroy an existing MetalView object.
void * GetLayer ()
 Get a pointer to the backing CAMetalLayer for the given view.
constexpr ResourceBase (RawPointer resource)
 Constructs from resource pointer.
constexpr ResourceBase (std::nullptr_t=nullptr)
 Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< MetalViewRaw >
constexpr ResourceBase (RawPointer resource)
 Constructs from resource pointer.
constexpr operator bool () const
 Converts to bool.
constexpr auto operator<=> (const ResourceBase &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::ResourceBase< MetalViewRaw >
using RawPointer
 The underlying raw pointer type.
using RawConstPointer
 The underlying const raw pointer type.

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
resourcea 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: