SDL::Camera Struct Reference

The opaque structure used to identify an opened SDL camera. More...

Inheritance diagram for SDL::Camera:

Public Member Functions
constexpr	Camera (CameraRaw resource) noexcept
	Constructs from raw Camera.
constexpr	Camera (Camera &&other) noexcept
	Move constructor.
	Camera (CameraID instance_id, OptionalRef< const CameraSpec > spec={})
	Open a video recording device (a "camera").
	~Camera ()
	Destructor.
constexpr Camera &	operator= (Camera &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::CameraBase
void	Close ()
	Use this function to shut down camera processing and close the camera device.
CameraPermissionState	GetPermissionState ()
	Query if camera access has been approved by the user.
CameraID	GetID ()
	Get the instance ID of an opened camera.
PropertiesRef	GetProperties ()
	Get the properties associated with an opened camera.
std::optional< CameraSpec >	GetFormat ()
	Get the spec that a camera is using when generating images.
CameraFrame	AcquireFrame (Uint64 *timestampNS=nullptr)
	Acquire a frame.
void	ReleaseFrame (CameraFrame &&lock)
	Release a frame of video acquired from a camera.
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< CameraRaw >
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< CameraRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< CameraRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

The opaque structure used to identify an opened SDL camera.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

Constructor & Destructor Documentation

Camera()

SDL::Camera::Camera ( CameraRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Camera.

Parameters

resource

a CameraRaw 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_camera.h