SDL::Environment Struct Reference

Handle to an owned environment. More...

Inheritance diagram for SDL::Environment:

Public Member Functions
constexpr	Environment (SDL_Environment *resource={})
	Constructs from the underlying resource.
constexpr	Environment (const Environment &other)=delete
constexpr	Environment (Environment &&other)=default
	Move constructor.
	~Environment ()
	Frees up resource when object goes out of scope.
Environment &	operator= (Environment other)
	Assignment operator.
constexpr	EnvironmentRef (const EnvironmentRef &other)
	Copy constructor.
constexpr	EnvironmentRef (EnvironmentRef &&other)
	Move constructor.
Public Member Functions inherited from SDL::EnvironmentRef
constexpr	EnvironmentRef (const EnvironmentRef &other)
	Copy constructor.
constexpr	EnvironmentRef (EnvironmentRef &&other)
	Move constructor.
constexpr	~EnvironmentRef ()=default
	Default constructor.
EnvironmentRef &	operator= (EnvironmentRef other)
	Assignment operator.
void	reset (SDL_Environment *newResource={})
	Destroy a set of environment variables.
	EnvironmentBase (bool populated)
	Create a set of environment variables.
Public Member Functions inherited from SDL::EnvironmentBase
	EnvironmentBase (bool populated)
	Create 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	Resource (T resource={})
	Constructs the underlying resource.
constexpr	Resource (std::nullptr_t)
	Equivalent to default ctor.
constexpr	Resource (std::nullopt_t)
	Equivalent to default ctor.
	Resource (const Resource &other)=delete
	Resource (Resource &&other)=delete
Public Member Functions inherited from SDL::Resource< SDL_Environment * >
constexpr	Resource (SDL_Environment * resource={})
	Constructs the underlying resource.
constexpr	Resource (std::nullptr_t)
	Equivalent to default ctor.
constexpr	Resource (std::nullopt_t)
	Equivalent to default ctor.
	Resource (const Resource &other)=delete
	Resource (Resource &&other)=delete
Resource &	operator= (const Resource &other)=delete
Resource &	operator= (Resource &&other)=delete
constexpr	operator bool () const
	True if contains a valid resource.
constexpr bool	operator== (const Resource &other) const=default
	Comparison.
constexpr bool	operator== (std::nullopt_t) const
	Comparison.
constexpr bool	operator== (std::nullptr_t) const
	Comparison.
constexpr SDL_Environment *	get () const
	Return contained resource;.
constexpr SDL_Environment *	release (SDL_Environment * newResource={})
	Return contained resource and empties or replace value.
constexpr const SDL_Environment *	operator-> () const
	Access to fields.
constexpr SDL_Environment *	operator-> ()
	Access to fields.

Detailed Description

Category:

Resource

See also

EnvironmentBase

EnvironmentRef

---

The documentation for this struct was generated from the following file:

• SDL3pp/SDL3pp_stdinc.h