SDL::AnimationDecoder Struct Reference

An object representing animation decoder. More...

Inheritance diagram for SDL::AnimationDecoder:

Public Member Functions
constexpr	AnimationDecoder (AnimationDecoderRaw resource) noexcept
	Constructs from raw AnimationDecoder.
constexpr	AnimationDecoder (AnimationDecoder &&other) noexcept
	Move constructor.
	AnimationDecoder (StringParam file)
	Create a decoder to read a series of images from a file.
	AnimationDecoder (IOStreamRef src, StringParam type, bool closeio=false)
	Create a decoder to read a series of images from an IOStream.
	AnimationDecoder (PropertiesRef props)
	Create an animation decoder with the specified properties.
	~AnimationDecoder ()
	Destructor.
constexpr AnimationDecoder &	operator= (AnimationDecoder &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::AnimationDecoderBase
void	Close ()
	Close an animation decoder, finishing any decoding.
PropertiesRef	GetProperties ()
	Get the properties of an animation decoder.
Surface	GetFrame (Uint64 *duration)
	Get the next frame in an animation decoder.
AnimationDecoderStatus	GetStatus ()
	Get the decoder status indicating the current state of the decoder.
void	Reset ()
	Reset an animation decoder.
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< AnimationDecoderRaw >
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< AnimationDecoderRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< AnimationDecoderRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

An object representing animation decoder.

Category:

Resource

Constructor & Destructor Documentation

AnimationDecoder()

SDL::AnimationDecoder::AnimationDecoder ( AnimationDecoderRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw AnimationDecoder.

Parameters

resource

a AnimationDecoderRaw 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_image.h