SDL::SharedObjectRef Struct Reference

Reference for SharedObject. More...

Inheritance diagram for SDL::SharedObjectRef:

Collaboration diagram for SDL::SharedObjectRef:

Public Member Functions
	SharedObjectRef (SharedObjectRaw resource) noexcept
	Constructs from raw SharedObject. More...
constexpr	SharedObjectRef (const SharedObject &resource) noexcept
	Constructs from SharedObject. More...
constexpr	SharedObjectRef (SharedObject &&resource) noexcept
	Constructs from SharedObject. More...
constexpr	SharedObjectRef (const SharedObjectRef &other) noexcept
	Copy constructor.
constexpr	SharedObjectRef (SharedObjectRef &&other) noexcept
	Move constructor.
	~SharedObjectRef ()
	Destructor.
constexpr SharedObjectRef &	operator= (const SharedObjectRef &other) noexcept=default
	Assignment operator.
constexpr	operator SharedObjectRaw () const noexcept
	Converts to SharedObjectRaw.
constexpr	SharedObject (std::nullptr_t=nullptr) noexcept
	Default ctor.
constexpr	SharedObject (const SharedObjectRaw resource) noexcept
	Constructs from SharedObjectRef. More...
constexpr	SharedObject (const SharedObject &other) noexcept=default
	Copy constructor.
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...
Public Member Functions inherited from SDL::SharedObject
constexpr	SharedObject (std::nullptr_t=nullptr) noexcept
	Default ctor.
constexpr	SharedObject (const SharedObjectRaw resource) noexcept
	Constructs from SharedObjectRef. 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.
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...

Additional Inherited Members
Protected Member Functions inherited from SDL::SharedObject
constexpr	SharedObject (const SharedObject &other) noexcept=default
	Copy constructor.
constexpr SharedObject &	operator= (const SharedObject &other) noexcept=default
	Assignment operator.

Detailed Description

This does not take ownership!

Constructor & Destructor Documentation

SharedObjectRef() [1/3]

SDL::SharedObjectRef::SharedObjectRef ( SharedObjectRaw  resource )

inlinenoexcept

Parameters

resource

a SharedObjectRaw.

This does not takes ownership!

SharedObjectRef() [2/3]

constexpr SDL::SharedObjectRef::SharedObjectRef ( const SharedObject &  resource )

inlineconstexprnoexcept

Parameters

resource

a SharedObject.

This does not takes ownership!

SharedObjectRef() [3/3]

constexpr SDL::SharedObjectRef::SharedObjectRef ( SharedObject &&  resource )

inlineconstexprnoexcept

Parameters

resource

a SharedObject.

This will release the ownership from resource!

Member Function 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 struct was generated from the following file:

• SDL3pp/SDL3pp_loadso.h