SDL::SharedObjectRef Struct Reference

Handle to a non owned sharedObject. More...

Inheritance diagram for SDL::SharedObjectRef:

Public Member Functions
constexpr	SharedObjectRef (const SharedObjectRef &other)
	Copy constructor.
constexpr	SharedObjectRef (SharedObjectRef &&other)
	Move constructor.
constexpr	~SharedObjectRef ()=default
	Default constructor.
SharedObjectRef &	operator= (SharedObjectRef other)
	Assignment operator.
void	reset (SDL_SharedObject *newResource={})
	Unload a shared object from memory.
void	Unload ()
	Unload a shared object from memory.
	SharedObjectBase (StringParam sofile)
	Dynamically load a shared object.
Public Member Functions inherited from SDL::SharedObjectBase
	SharedObjectBase (StringParam sofile)
	Dynamically load a shared object.
FunctionPointer	LoadFunction (StringParam name)
	Look up the address of the named function in a shared object.
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_SharedObject * >
constexpr	Resource (SDL_SharedObject * 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_SharedObject *	get () const
	Return contained resource;.
constexpr SDL_SharedObject *	release (SDL_SharedObject * newResource={})
	Return contained resource and empties or replace value.
constexpr const SDL_SharedObject *	operator-> () const
	Access to fields.
constexpr SDL_SharedObject *	operator-> ()
	Access to fields.

Detailed Description

Category:

Resource

See also

SharedObjectBase

SharedObject

Member Function Documentation

reset()

void SDL::SharedObjectRef::reset ( SDL_SharedObject *  newResource = {} )

inline

Note that any pointers from this object looked up through SharedObjectBase.LoadFunction() will no longer be valid.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

SharedObjectBase.SharedObjectBase

SharedObjectBase()

SDL::SharedObjectBase::SharedObjectBase ( StringParam  sofile )

inline

Parameters

sofile

a system-dependent name of the object file.

Postcondition

an opaque pointer to the object handle or nullptr on failure; call GetError() for more information.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

SharedObjectBase.LoadFunction

SharedObjectRef.Unload

Unload()

void SDL::SharedObjectRef::Unload ( )

inline

Note that any pointers from this object looked up through SharedObjectBase.LoadFunction() will no longer be valid.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

SharedObjectBase.SharedObjectBase

---

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

• SDL3pp/SDL3pp_loadso.h