CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
ImageIoPlugin Class Reference

Description of an image file format. More...

#include <cc/ImageIoPlugin>

Inheritance diagram for ImageIoPlugin:

Public Member Functions

 ImageIoPlugin ()=default
 Create a null image plugin.
 
 ImageIoPlugin (const String &mediaType, const String &fileSuffix="")
 Get access to an image I/O plugin for given mediaType and/or fileSuffix.
 
String mediaType () const
 Unqiue name identifying this plugin.
 
List< StringfileSuffix () const
 Common file name extensions used for this image format.
 
bool detect (const Bytes &data, Out< int > width=None{}, Out< int > height=None{}) const
 Check if data is of this image file format and optionally return the width and height of the image.
 
Image decode (const Bytes &data) const
 Load the image from given data.
 
bool decodeInto (InOut< Image > image, const Bytes &data) const
 Load image from data.
 
void encode (const Stream &sink, const Image &image) const
 Write encoded image to sink.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Static Public Member Functions

static ImageIoPlugin detect (const String &path, const Bytes &data, Out< int > width=None{}, Out< int > height=None{})
 Detect image I/O plugin for loading an image.
 

Protected Member Functions

 ImageIoPlugin (State *newState)
 
const State & me () const
 
- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 

Additional Inherited Members

- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

Description of an image file format.

See also
ImageIoPluginManager

Constructor & Destructor Documentation

◆ ImageIoPlugin() [1/2]

ImageIoPlugin ( )
default

Create a null image plugin.

◆ ImageIoPlugin() [2/2]

ImageIoPlugin ( const String & mediaType,
const String & fileSuffix = "" )
explicit

Get access to an image I/O plugin for given mediaType and/or fileSuffix.

Member Function Documentation

◆ detect() [1/2]

ImageIoPlugin detect ( const String & path,
const Bytes & data,
Out< int > width = None{},
Out< int > height = None{} )
static

Detect image I/O plugin for loading an image.

Parameters
pathFile path
dataFile contents
widthReturns the image width
heightReturns the image height
Returns
ImageIoPlugin needed to load the image

◆ mediaType()

String mediaType ( ) const

Unqiue name identifying this plugin.

◆ fileSuffix()

List< String > fileSuffix ( ) const

Common file name extensions used for this image format.

◆ detect() [2/2]

bool detect ( const Bytes & data,
Out< int > width = None{},
Out< int > height = None{} ) const

Check if data is of this image file format and optionally return the width and height of the image.

◆ decode()

Image decode ( const Bytes & data) const

Load the image from given data.

Returns
Loaded image if decoding data was successful
A null image if decoding data failed

◆ decodeInto()

bool decodeInto ( InOut< Image > image,
const Bytes & data ) const

Load image from data.

Parameters
imageTarget image (output is scaled to match the user-defined size)
dataEncoded image data
Returns
true if image could be loaded successfully

◆ encode()

void encode ( const Stream & sink,
const Image & image ) const

Write encoded image to sink.

Parameters
sinkOutput sink to write the encoded image to
imageSource image