SDL::SharedObject Class Reference

An opaque datatype that represents a loaded shared object. More...

Inheritance diagram for SDL::SharedObject:

Public Member Functions
constexpr	SharedObject (std::nullptr_t=nullptr) noexcept
	Default ctor.
constexpr	SharedObject (const SharedObjectRaw resource) noexcept
	Constructs from SharedObjectParam. More...
constexpr	SharedObject (SharedObject &&other) noexcept
	Move constructor.
constexpr	SharedObject (const SharedObjectRef &other)=delete
constexpr	SharedObject (SharedObjectRef &&other)=delete
	SharedObject (StringParam sofile)
	Dynamically load a shared object. More...
	~SharedObject ()
	Destructor.
constexpr SharedObject &	operator= (SharedObject &&other) noexcept
	Assignment operator.
constexpr SharedObjectRaw	get () const noexcept
	Retrieves underlying SharedObjectRaw.
constexpr SharedObjectRaw	release () noexcept
	Retrieves underlying SharedObjectRaw and clear this.
constexpr auto	operator<=> (const SharedObject &other) const noexcept=default
	Comparison.
constexpr	operator bool () const noexcept
	Converts to bool.
constexpr	operator SharedObjectParam () const noexcept
	Converts to SharedObjectParam.
void	Unload ()
	Unload a shared object from memory. More...
FunctionPointer	LoadFunction (StringParam name)
	Look up the address of the named function in a shared object. More...

Protected Member Functions
constexpr	SharedObject (const SharedObject &other) noexcept=default
	Copy constructor.
constexpr SharedObject &	operator= (const SharedObject &other) noexcept=default
	Assignment operator.

Detailed Description

Since

This datatype is available since SDL 3.2.0.

See also

SharedObject.SharedObject

SharedObject.LoadFunction

SharedObject.Unload

Category:

Resource

Constructor & Destructor Documentation

SharedObject() [1/2]

constexpr SDL::SharedObject::SharedObject ( const SharedObjectRaw  resource )

inlineexplicitconstexprnoexcept

Parameters

resource

a SharedObjectRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

SharedObject() [2/2]

SDL::SharedObject::SharedObject ( 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

SharedObject.LoadFunction

SharedObject.Unload

---

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

• SDL3pp/SDL3pp_loadso.h