SDL::AnimationEncoder Struct Reference

An object representing the encoder context. More...

Inheritance diagram for SDL::AnimationEncoder:

Public Member Functions
constexpr	AnimationEncoder (AnimationEncoderRaw resource) noexcept
	Constructs from raw AnimationEncoder.
constexpr	AnimationEncoder (const AnimationEncoder &other)=delete
	Copy constructor.
constexpr	AnimationEncoder (AnimationEncoder &&other) noexcept
	Move constructor.
constexpr	AnimationEncoder (const AnimationEncoderRef &other)=delete
constexpr	AnimationEncoder (AnimationEncoderRef &&other)=delete
	AnimationEncoder (StringParam file)
	Create an encoder to save a series of images to a file.
	AnimationEncoder (IOStreamRef dst, StringParam type, bool closeio=false)
	Create an encoder to save a series of images to an IOStream.
	AnimationEncoder (PropertiesRef props)
	Create an animation encoder with the specified properties.
	~AnimationEncoder ()
	Destructor.
constexpr AnimationEncoder &	operator= (AnimationEncoder &&other) noexcept
	Assignment operator.
AnimationEncoder &	operator= (const AnimationEncoder &other)=delete
	Assignment operator.
void	Close ()
	Close an animation encoder, finishing any encoding.
void	AddFrame (SurfaceRef surface, Uint64 duration)
	Add a frame to an animation encoder.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< AnimationEncoderRaw >
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBase &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::ResourceBase< AnimationEncoderRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

An object representing the encoder context.

Category:

Resource

Constructor & Destructor Documentation

AnimationEncoder()

SDL::AnimationEncoder::AnimationEncoder ( AnimationEncoderRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw AnimationEncoder.

Parameters

resource

a AnimationEncoderRaw 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