The Ocean Media WIC Library provides media functionalities based on the Microsoft's Windows Imaging Component. More...

Collaboration diagram for Ocean Media Windows Imaging Component (WIC) Library:

Data Structures
class	Ocean::Media::WIC::Image
	This class implements read and write functions for all file formats supported by the WIC media library. More...

class	Ocean::Media::WIC::WICBufferImage
	This class implements a buffer image class for WIC. More...

class	Ocean::Media::WIC::WICBufferImageRecorder
	This class implements a buffer image recorder for WIC. More...

class	Ocean::Media::WIC::WICImage
	This class implements an image class for WIC. More...

class	Ocean::Media::WIC::WICImageRecorder
	This class implements an image recorder for WIC. More...

class	Ocean::Media::WIC::WICImageSequence
	This class implements an image sequence for WIC. More...

class	Ocean::Media::WIC::WICLibrary
	This class implements the WIC library. More...

class	Ocean::Media::WIC::WICObject
	This class is the base class for all object inside this library. More...

Typedefs
template<typename T >
using	Ocean::Media::WIC::ScopedWICObject = ScopedObjectCompileTimeVoidT< T *, release >
	Template specialization for ScopedObjectCompileTimeVoid using the release() function to release WIC objects.

using	Ocean::Media::WIC::ScopedIPropertyBag2 = ScopedWICObject< IPropertyBag2 >
	Definition of a scoped object holding an IPropertyBag2 object.

using	Ocean::Media::WIC::ScopedIStream = ScopedWICObject< IStream >
	Definition of a scoped object holding an IStream object.

using	Ocean::Media::WIC::ScopedIWICBitmapDecoder = ScopedWICObject< IWICBitmapDecoder >
	Definition of a scoped object holding an IWICBitmapDecoder object.

using	Ocean::Media::WIC::ScopedIWICBitmapEncoder = ScopedWICObject< IWICBitmapEncoder >
	Definition of a scoped object holding an IWICBitmapEncoder object.

using	Ocean::Media::WIC::ScopedIWICBitmapEncoderInfo = ScopedWICObject< IWICBitmapEncoderInfo >
	Definition of a scoped object holding an IWICBitmapEncoderInfo object.

using	Ocean::Media::WIC::ScopedIWICBitmapFrameDecode = ScopedWICObject< IWICBitmapFrameDecode >
	Definition of a scoped object holding an IWICBitmapFrameDecode object.

using	Ocean::Media::WIC::ScopedIWICBitmapFrameEncode = ScopedWICObject< IWICBitmapFrameEncode >
	Definition of a scoped object holding an IWICBitmapFrameEncode object.

using	Ocean::Media::WIC::ScopedIWICFormatConverter = ScopedWICObject< IWICFormatConverter >
	Definition of a scoped object holding an IWICFormatConverter object.

using	Ocean::Media::WIC::ScopedIWICImagingFactory = ScopedWICObject< IWICImagingFactory >
	Definition of a scoped object holding an IWICImagingFactory object.

using	Ocean::Media::WIC::ScopedIWICPalette = ScopedWICObject< IWICPalette >
	Definition of a scoped object holding an IWICPalette object.

using	Ocean::Media::WIC::ScopedIWICStream = ScopedWICObject< IWICStream >
	Definition of a scoped object holding an IWICStream object.

Functions
bool OCEAN_MEDIA_WIC_EXPORT	pluginLoad ()
	Tries to load the plugin and initializes all internal 3rd party libraries.

bool OCEAN_MEDIA_WIC_EXPORT	pluginUnload ()
	Tries to unload the plugin and all internal resources of 3rd party libraries.

OCEAN_MEDIA_WIC_EXPORT std::string	Ocean::Media::WIC::nameWICLibrary ()
	Returns the name of this media WIC library.

void	Ocean::Media::WIC::registerWICLibrary ()
	Registers this media library at the global library manager.

bool	Ocean::Media::WIC::unregisterWICLibrary ()
	Unregisters this media library at the global library manager.

template<class T >
void	Ocean::Media::WIC::release (T *object)
	This functions allows to release a WIC object if it does exist.

Detailed Description

The Ocean Media WIC Library provides media functionalities based on the Microsoft's Windows Imaging Component.

The library is available on Windows platforms.

Typedef Documentation

◆ ScopedIPropertyBag2

using Ocean::Media::WIC::ScopedIPropertyBag2 = typedef ScopedWICObject<IPropertyBag2>

Definition of a scoped object holding an IPropertyBag2 object.

The wrapped IPropertyBag2 object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIStream

using Ocean::Media::WIC::ScopedIStream = typedef ScopedWICObject<IStream>

Definition of a scoped object holding an IStream object.

The wrapped IStream object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICBitmapDecoder

using Ocean::Media::WIC::ScopedIWICBitmapDecoder = typedef ScopedWICObject<IWICBitmapDecoder>

Definition of a scoped object holding an IWICBitmapDecoder object.

The wrapped IWICBitmapDecoder object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICBitmapEncoder

using Ocean::Media::WIC::ScopedIWICBitmapEncoder = typedef ScopedWICObject<IWICBitmapEncoder>

Definition of a scoped object holding an IWICBitmapEncoder object.

The wrapped IWICBitmapEncoder object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICBitmapEncoderInfo

using Ocean::Media::WIC::ScopedIWICBitmapEncoderInfo = typedef ScopedWICObject<IWICBitmapEncoderInfo>

Definition of a scoped object holding an IWICBitmapEncoderInfo object.

The wrapped IWICBitmapEncoderInfo object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICBitmapFrameDecode

using Ocean::Media::WIC::ScopedIWICBitmapFrameDecode = typedef ScopedWICObject<IWICBitmapFrameDecode>

Definition of a scoped object holding an IWICBitmapFrameDecode object.

The wrapped IWICBitmapFrameDecode object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICBitmapFrameEncode

using Ocean::Media::WIC::ScopedIWICBitmapFrameEncode = typedef ScopedWICObject<IWICBitmapFrameEncode>

Definition of a scoped object holding an IWICBitmapFrameEncode object.

The wrapped IWICBitmapFrameEncode object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICFormatConverter

using Ocean::Media::WIC::ScopedIWICFormatConverter = typedef ScopedWICObject<IWICFormatConverter>

Definition of a scoped object holding an IWICFormatConverter object.

The wrapped IWICFormatConverter object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICImagingFactory

using Ocean::Media::WIC::ScopedIWICImagingFactory = typedef ScopedWICObject<IWICImagingFactory>

Definition of a scoped object holding an IWICImagingFactory object.

The wrapped IWICImagingFactory object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICPalette

using Ocean::Media::WIC::ScopedIWICPalette = typedef ScopedWICObject<IWICPalette>

Definition of a scoped object holding an IWICPalette object.

The wrapped IWICPalette object will be released automatically once the scoped object does not exist anymore.

◆ ScopedIWICStream

using Ocean::Media::WIC::ScopedIWICStream = typedef ScopedWICObject<IWICStream>

Definition of a scoped object holding an IWICStream object.

The wrapped IWICStream object will be released automatically once the scoped object does not exist anymore.

◆ ScopedWICObject

template<typename T >

using Ocean::Media::WIC::ScopedWICObject = typedef ScopedObjectCompileTimeVoidT<T*, release>

Template specialization for ScopedObjectCompileTimeVoid using the release() function to release WIC objects.

Template Parameters

T	The data type of the wrapped object

Function Documentation

◆ nameWICLibrary()

OCEAN_MEDIA_WIC_EXPORT std::string Ocean::Media::WIC::nameWICLibrary ( )

Returns the name of this media WIC library.

◆ pluginLoad()

bool OCEAN_MEDIA_WIC_EXPORT pluginLoad ( )

Tries to load the plugin and initializes all internal 3rd party libraries.

Make sure that the plugin will be loaded only once!

Returns: True, if succeeded

See also: pluginUnload().

◆ pluginUnload()

bool OCEAN_MEDIA_WIC_EXPORT pluginUnload ( )

Tries to unload the plugin and all internal resources of 3rd party libraries.

Make sure that all resources of this plugin has been released before!

Returns: True, if succeeded

See also: pluginLoad().

◆ registerWICLibrary()

void Ocean::Media::WIC::registerWICLibrary ( )

Registers this media library at the global library manager.

This function calls WICLibrary::registerLibrary() only.

◆ release()

template<class T >

void Ocean::Media::WIC::release ( T * object )

This functions allows to release a WIC object if it does exist.

Parameters

object The WIC object to be released

◆ unregisterWICLibrary()

bool Ocean::Media::WIC::unregisterWICLibrary ( )

Unregisters this media library at the global library manager.

This function calls WICLibrary::unregisterLibrary() only.

Returns: True, if succeeded

Data Structures

Typedefs

Functions