SDL::Sensor Struct Reference

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

Inheritance diagram for SDL::Sensor:

Public Member Functions
constexpr	Sensor (SensorRaw resource) noexcept
	Constructs from raw Sensor.
constexpr	Sensor (const Sensor &other)=delete
	Copy constructor.
constexpr	Sensor (Sensor &&other) noexcept
	Move constructor.
constexpr	Sensor (const SensorRef &other)=delete
constexpr	Sensor (SensorRef &&other)=delete
	Sensor (SensorID instance_id)
	Open a sensor for use.
	~Sensor ()
	Destructor.
constexpr Sensor &	operator= (Sensor &&other) noexcept
	Assignment operator.
Sensor &	operator= (const Sensor &other)=delete
	Assignment operator.
void	Close ()
	Close a sensor previously opened with OpenSensor().
PropertiesRef	GetProperties ()
	Get the properties associated with a sensor.
const char *	GetName ()
	Get the implementation dependent name of a sensor.
SensorType	GetType ()
	Get the type of a sensor.
int	GetNonPortableType ()
	Get the platform dependent type of a sensor.
SensorID	GetID ()
	Get the instance ID of a sensor.
void	GetData (float *data, int num_values)
	Get the current state of an opened sensor.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< SensorRaw >
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< SensorRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

The opaque structure used to identify an opened SDL sensor.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

Constructor & Destructor Documentation

Sensor()

SDL::Sensor::Sensor ( SensorRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Sensor.

Parameters

resource

a SensorRaw 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_sensor.h