SDL::Thread Struct Reference

The SDL thread object. More...

Inheritance diagram for SDL::Thread:

Public Member Functions
constexpr	Thread (ThreadRaw resource) noexcept
	Constructs from raw Thread.
constexpr	Thread (Thread &&other) noexcept
	Move constructor.
	Thread (ThreadFunction fn, StringParam name, void *data)
	Create a new thread with a default stack size.
	Thread (ThreadCB fn, StringParam name)
	Create a new thread with a default stack size.
	Thread (PropertiesRef props)
	Create a new thread with with the specified properties.
	~Thread ()
	Destructor.
constexpr Thread &	operator= (Thread &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::ThreadBase
void	Detach ()
	Let a thread clean up on exit without intervention.
const char *	GetName () const
	Get the thread name as it was specified in CreateThread().
ThreadID	GetID () const
	Get the thread identifier for the specified thread.
void	Wait (int *status)
	Wait for a thread to finish.
ThreadState	GetState () const
	Get the current state of a thread.
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< ThreadRaw >
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< ThreadRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Static Public Member Functions inherited from SDL::ThreadBase
static void	SetCurrentPriority (ThreadPriority priority)
	Set the priority for the current thread.
Protected Member Functions inherited from SDL::ResourceBaseT< ThreadRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

The SDL thread object.

These are opaque data.

Since

This datatype is available since SDL 3.2.0.

See also

CreateThread

WaitThread

Category:

Resource

Constructor & Destructor Documentation

Thread()

SDL::Thread::Thread ( ThreadRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Thread.

Parameters

resource

a ThreadRaw 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_thread.h