SDL::Environment Struct Reference

A thread-safe set of environment variables. More...

Inheritance diagram for SDL::Environment:

Public Member Functions
constexpr	Environment (EnvironmentRaw resource) noexcept
	Constructs from raw Environment.
constexpr	Environment (Environment &&other) noexcept
	Move constructor.
	Environment (bool populated)
	Create a set of environment variables.
	~Environment ()
	Destructor.
constexpr Environment &	operator= (Environment &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::EnvironmentBase
void	Destroy ()
	Destroy a set of environment variables.
const char *	GetVariable (StringParam name)
	Get the value of a variable in the environment.
OwnArray< char * >	GetVariables ()
	Get all variables in the environment.
Uint64	GetVariableCount ()
	Get the Variables count.
void	SetVariable (StringParam name, StringParam value, bool overwrite)
	Set the value of a variable in the environment.
void	UnsetVariable (StringParam name)
	Clear a variable from the environment.
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< EnvironmentRaw >
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< EnvironmentRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< EnvironmentRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

A thread-safe set of environment variables.

Since

This struct is available since SDL 3.2.0.

See also

GetEnvironment

CreateEnvironment

GetEnvironmentVariable

GetEnvironmentVariables

SetEnvironmentVariable

UnsetEnvironmentVariable

DestroyEnvironment

Category:

Resource

Constructor & Destructor Documentation

Environment()

SDL::Environment::Environment ( EnvironmentRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Environment.

Parameters

resource

a EnvironmentRaw 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_stdinc.h