Inheritance diagram for ColorIO:

Public Member Functions
CoreString	get_default_color_space_from_ext (const CoreString &extension)

unsigned int	get_color_space_tag_count () const

const CoreString &	get_color_space_tag (unsigned int i) const

Public Member Functions inherited from EventObject
	EventObject ()
	Constructor.

	EventObject (const EventObject &src)
	Copy Constructor.

virtual	~EventObject () override
	Destructor.

void	connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
	Connects this to an object to listen to a specific event.

void	connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
	Connects this to an object to listen any of its events.

bool	disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)

bool	disconnect_all (EventObject &sender)
	Disconnects from all objects sender was listening on.

void	disconnect_all ()
	Disconnects from all objects we were listening on.

void	remove_all_connection ()
	Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.

void	raise_event (const CoreString &event_id) const
	sends an event

void	raise_event (const EventInfo &event_info) const
	sends an event

bool	is_connected (EventObject &sender, const CoreString &event_id, void *data)

void	set_mute (const bool &mute)
	Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.

bool	is_mute () const
	Returns if object is muted.

CoreArray< EventObject * >	get_senders () const

unsigned int	get_sender_count () const

unsigned int	get_receiver_count () const

virtual size_t	get_memory_size () const override

void	connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
	Connects this to an object to listen to a specific event.

void	connect (EventObject &sender, EventMethod event_cb, void *data=0)
	Connects this to an object to listen any of its events.

bool	disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
	Disconnects this from an object for a specific event.

Public Member Functions inherited from CoreCustomData
	CoreCustomData (const CoreCustomData &src)

void	add_custom_data (void *key, const bool &data)

void	add_custom_data (void *key, const int &data)

void	add_custom_data (void *key, const unsigned int &data)

void	add_custom_data (void key, const char data)

void	add_custom_data (void *key, const CoreString &data)

void	add_custom_data (void *key, const double &data)

void	add_custom_data (void key, void data)

void	remove_custom_data (void *key)

void	remove_all_custom_data ()

void	set_custom_data (void *key, const bool &data)

void	set_custom_data (void *key, const int &data)

void	set_custom_data (void *key, const unsigned int &data)

void	set_custom_data (void *key, const double &data)

void	set_custom_data (void key, const char data)

void	set_custom_data (void *key, const CoreString &data)

void	set_custom_data (void key, void data)

void	get_custom_data (void *key, bool &data) const

void	get_custom_data (void *key, int &data) const

void	get_custom_data (void *key, unsigned int &data) const

void	get_custom_data (void *key, double &data) const

void	get_custom_data (void *key, CoreString &data) const

void	get_custom_data (void key, void &data) const

Public Member Functions inherited from CoreBaseObject
bool	is_kindof (const CoreBaseObject &object) const

CoreString	get_class_info_name () const

const unsigned long &	get_class_info_id () const

virtual bool	is_kindof (const CoreClassInfo &cinfo) const

virtual const CoreClassInfo &	get_class_info () const

template<class T >
T *	cast ()

template<class T >
const T *	cast () const

Public Member Functions inherited from CoreBaseType
bool	is_kindof (const CoreClassInfo &cinfo) const

Static Public Member Functions
static bool	init (OfApp *of_app)

static void	destroy ()

static ColorIO *	get_instance ()

static bool	load_config (ParserEntry *preferences)

static bool	save_config (ParserEntry *preferences)

static bool	convert_buffer (float *buffer, const unsigned int &width, const unsigned int height, const unsigned int &channel_count, const CoreString &to_space, const CoreString &from_space)

static bool	convert_buffers (float r_buffer, float g_buffer, float b_buffer, float a_buffer, const unsigned int &width, const unsigned int height, const CoreString &to_space, const CoreString &from_space)

static bool	convert_CDL_buffers (float r_buffer, float g_buffer, float b_buffer, float a_buffer, const unsigned int &width, const unsigned int height, const CoreString &to_space, const CoreString &from_space)

static const CoreBasicArray < CoreString > &	get_color_space_names ()

static bool	color_space_exists (CoreBasicString color_space)

static const CoreBasicArray < CoreString > &	get_display_view_names ()

static CoreString	get_color_space_from_display_view (CoreBasicString display_view)

static bool	display_view_exists (CoreBasicString display_view)

static bool	get_display_view (const CoreString &display_view, CoreString &display, CoreString &view)

static bool	get_default_display_view (CoreString &display, CoreString &view)

static CoreString	get_default_display_view ()

static bool	is_legacy_builtin_color_space (CoreBasicString color_space)

static CoreString	convert_legacy_builtin_color_space (CoreBasicString color_space)

static CoreString	convert_legacy_preferences_display_color_space_to_display_view (CoreBasicString display_color_space)

static CoreString	convert_legacy_widget_display_color_space_to_display_view (CoreBasicString display_color_space)

static const CoreString &	get_ROLE_SCENE_LINEAR ()

static CoreString	get_default_color_space_name ()

static const CoreString &	get_default_color_picker_space_name ()

static CoreString	get_color_space_name (unsigned int id)

static unsigned int	get_color_space_index (const CoreString &name)

static CoreString	get_full_color_space_name (const CoreString &name)

static CoreString	get_default_CDL_name ()

static CoreString	get_CDL_name (unsigned int id)

static unsigned int	get_CDL_index (const CoreString &name)

static const CoreString &	get_role_color_space (const int index)

Static Public Member Functions inherited from EventObject
static void	connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
	Connects to an object to listen to a specific event.

static void	connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
	Connects to an object to listen any of its events.

static bool	disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)

static void	raise_event (EventObject &sender, const CoreString &event_id)
	Sends an event.

static void	raise_event (EventObject &sender, const EventInfo &event_info)
	Sends an event.

static void	connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
	Connects to an object to listen to a specific event.

static void	connect (EventObject &sender, EventFunction event_cb, void *data=0)
	Connects to an object to listen any of its events.

static void	connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
	Static version of the above function.

static bool	disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
	Disconnects this from an object for a specific event.

Static Public Member Functions inherited from CoreCustomData
static void *	get_custom_data_key (const CoreString &key)

Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfo &	class_info ()

template<class T >
static T *	cast (CoreBaseObject *object)

template<class T >
static const T *	cast (const CoreBaseObject *object)

Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfo &	class_info ()
	Get the type descriptor of this instance.

Static Public Attributes
static CoreString	s_default_scene_linear

static CoreString	s_default_color_picking

Additional Inherited Members
Public Types inherited from EventObject
typedef void(*	EventInfoFunction )(EventObject &, const EventInfo &, void *)
	event callback signature for free functions / static methods.

typedef void(EventObject::*	EventInfoMethod )(EventObject &, const EventInfo &, void *)
	event callback signature for methods.

typedef void(*	EventFunction )(EventObject &, const CoreString &, void *)

typedef void(EventObject::*	EventMethod )(EventObject &, const CoreString &, void *)

Detailed Description

Public interface for color management (color spaces, roles, displays and views, CDLs, etc.).

Member Function Documentation

bool ColorIO::init ( OfApp * of_app )

static

Initializes ColorIO: OCIO config, CDLs config, auto-detection (file-format/color-space mapping).

Warning: In order to create ColorIO temporary files in the correct temporary folder, this function must called after creating the application preferences so that application's temp folder is defined.

Parameters

of_app Optional application instance.

Returns: true on initialization success, false otherwise.

Member Data Documentation

CoreString ColorIO::s_default_color_picking

static

Default color space used for the color_picking role. The value is either "Use Default" or an actual color space name.

CoreString ColorIO::s_default_scene_linear

static

Default color space used for the scene_linear role. The value is either "Use scene_linear" or an actual color space name.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation