OcioConfigInterface Class Reference

#include <gfx_image_ocio.h>

Detailed Description

Private.

Classes
struct	ColorSpace
struct	Display
struct	Role

Public Types
enum class	DISPLAY_TYPE {   FROM_CONFIG ,   VIRTUAL_MONITOR ,   VIRTUAL_ICC }
enum class	COLORSPACE_NAME {   SRGB_NON_LINEAR ,   SRGB_LINEAR ,   RAW }
enum class	CONVERSIONFUNCTION_FLAGS {   NONE ,   INVERSE_DIRECTION ,   PIXELFORMAT_UINT8 }

Public Member Functions
enum maxon::OcioConfigInterface::DISPLAY_TYPE	MAXON_ENUM_LIST_CLASS (DISPLAY_TYPE)
enum maxon::OcioConfigInterface::COLORSPACE_NAME	MAXON_ENUM_LIST_CLASS (COLORSPACE_NAME)
enum maxon::OcioConfigInterface::CONVERSIONFUNCTION_FLAGS	MAXON_ENUM_FLAGS_CLASS (CONVERSIONFUNCTION_FLAGS)
MAXON_METHOD Bool	IsEqual (const OcioConfigInterface *other) const
MAXON_METHOD HashInt	GetHashCode () const
MAXON_METHOD String	ToString (const FormatStatement *fs=nullptr) const
MAXON_METHOD const Url &	GetConfigUrl () const
MAXON_METHOD Result< CString >	AddIccDisplayProfile (const Url &url)
MAXON_METHOD const BaseArray< ColorSpace > &	GetColorSpaces () const
MAXON_METHOD const BaseArray< Role > &	GetRoles () const
MAXON_METHOD Result< OcioProcessor >	CreateConversionFunction (const CString &inputColorSpace, const CString &outputColorSpace, CONVERSIONFUNCTION_FLAGS flags) const
MAXON_METHOD Result< OcioProcessor >	CreateConversionFunctionWithViewTransform (const CString &inputColorSpace, const CString &viewTransform, const CString &displayColorSpace, CONVERSIONFUNCTION_FLAGS flags) const
MAXON_METHOD Result< OcioProcessor >	CreateGpuProcessor (const CString &inputColorSpace, const CString &outputColorSpace, COLORCONVERSIONFLAGS_GPU flags, COLORCONVERSION_OPTIMIZATION_GPU_FLAGS optimization) const
MAXON_METHOD Result< OcioProcessor >	CreateGpuProcessorWithViewTransform (const CString &inputColorSpace, const CString &viewTransform, const CString &displayColorSpace, COLORCONVERSIONFLAGS_GPU flags, COLORCONVERSION_OPTIMIZATION_GPU_FLAGS optimization) const
MAXON_METHOD Bool	ComputeColorTransformMatrix (const CString &srcColorSpaceName, const CString &dstColorSpaceName, SquareMatrix32 &retMatrix) const
MAXON_METHOD Result< CString >	GetColorSpaceFamily (const CString &colorSpaceName) const
MAXON_METHOD Result< BaseArray< CString > >	GetColorSpaceCategories (const CString &colorSpaceName) const
MAXON_METHOD Result< BaseArray< CString > >	GetRenderingColorSpaceNames () const
MAXON_METHOD Result< BaseArray< Display > >	GetDisplays (Bool activeOnly) const
MAXON_METHOD Result< BaseArray< CString > >	GetViewTransformNames (const CString &displayColorSpaceName) const
MAXON_METHOD const CString &	GetColorSpaceName (COLORSPACE_NAME name) const
MAXON_METHOD const CString &	GetDefaultDisplayName () const
MAXON_METHOD const BaseArray< CString > &	GetLutLocations () const
MAXON_METHOD const BaseArray< CString > &	GetMonitorNames () const
MAXON_METHOD Result< CString >	GetColorspaceNameForFile (const Url &path) const
MAXON_METHOD const CString &	GetMonitorColorSpaceName (UInt64 monitorSystemHandle) const
MAXON_METHOD void	SetDisallowFileRules (Bool value=true)

Static Public Member Functions
static MAXON_METHOD Result< OcioConfig >	Load (const Url &url)

Public Attributes
struct maxon::OcioConfigInterface::Display	MAXON_ENUM_LIST_CLASS

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (OcioConfigInterface, MAXON_REFERENCE_ALWAYS_COPY_ON_WRITE, "net.maxon.image.interface.ocioconfig")

Static Private Member Functions
static MAXON_METHOD Result< void >	DescribeIO (const DataSerializeInterface &stream)

Member Enumeration Documentation

DISPLAY_TYPE

enum DISPLAY_TYPE

strong

Enumerator
FROM_CONFIG	Display is defined in config file.
VIRTUAL_MONITOR	Virtual display, created from monitor.
VIRTUAL_ICC	Virtual display, created from icc file.

COLORSPACE_NAME

enum COLORSPACE_NAME

strong

Enumerator
SRGB_NON_LINEAR
SRGB_LINEAR
RAW

CONVERSIONFUNCTION_FLAGS

enum CONVERSIONFUNCTION_FLAGS

strong

Enumerator
NONE
INVERSE_DIRECTION
PIXELFORMAT_UINT8

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( OcioConfigInterface  , MAXON_REFERENCE_ALWAYS_COPY_ON_WRITE  , "net.maxon.image.interface.ocioconfig"    )

private

MAXON_ENUM_LIST_CLASS() [1/2]

enum maxon::OcioConfigInterface::DISPLAY_TYPE MAXON_ENUM_LIST_CLASS

(

DISPLAY_TYPE

)

MAXON_ENUM_LIST_CLASS() [2/2]

enum maxon::OcioConfigInterface::COLORSPACE_NAME MAXON_ENUM_LIST_CLASS

(

COLORSPACE_NAME

)

MAXON_ENUM_FLAGS_CLASS()

enum maxon::OcioConfigInterface::CONVERSIONFUNCTION_FLAGS MAXON_ENUM_FLAGS_CLASS

(

CONVERSIONFUNCTION_FLAGS

)

IsEqual()

MAXON_METHOD Bool IsEqual

(

const OcioConfigInterface *

other

)

const

GetHashCode()

MAXON_METHOD HashInt GetHashCode

(

)

const

ToString()

MAXON_METHOD String ToString

(

const FormatStatement *

fs = nullptr

)

const

Load()

static MAXON_METHOD Result<OcioConfig> Load ( const Url &  url )

static

GetConfigUrl()

MAXON_METHOD const Url& GetConfigUrl

(

)

const

AddIccDisplayProfile()

MAXON_METHOD Result<CString> AddIccDisplayProfile

(

const Url &

url

)

GetColorSpaces()

MAXON_METHOD const BaseArray<ColorSpace>& GetColorSpaces

(

)

const

GetRoles()

MAXON_METHOD const BaseArray<Role>& GetRoles

(

)

const

CreateConversionFunction()

MAXON_METHOD Result<OcioProcessor> CreateConversionFunction	(	const CString &	inputColorSpace,
		const CString &	outputColorSpace,
		CONVERSIONFUNCTION_FLAGS	flags
	)		const

CreateConversionFunctionWithViewTransform()

MAXON_METHOD Result<OcioProcessor> CreateConversionFunctionWithViewTransform	(	const CString &	inputColorSpace,
		const CString &	viewTransform,
		const CString &	displayColorSpace,
		CONVERSIONFUNCTION_FLAGS	flags
	)		const

CreateGpuProcessor()

MAXON_METHOD Result<OcioProcessor> CreateGpuProcessor	(	const CString &	inputColorSpace,
		const CString &	outputColorSpace,
		COLORCONVERSIONFLAGS_GPU	flags,
		COLORCONVERSION_OPTIMIZATION_GPU_FLAGS	optimization
	)		const

CreateGpuProcessorWithViewTransform()

MAXON_METHOD Result<OcioProcessor> CreateGpuProcessorWithViewTransform	(	const CString &	inputColorSpace,
		const CString &	viewTransform,
		const CString &	displayColorSpace,
		COLORCONVERSIONFLAGS_GPU	flags,
		COLORCONVERSION_OPTIMIZATION_GPU_FLAGS	optimization
	)		const

ComputeColorTransformMatrix()

MAXON_METHOD Bool ComputeColorTransformMatrix	(	const CString &	srcColorSpaceName,
		const CString &	dstColorSpaceName,
		SquareMatrix32 &	retMatrix
	)		const

GetColorSpaceFamily()

MAXON_METHOD Result<CString> GetColorSpaceFamily

(

const CString &

colorSpaceName

)

const

GetColorSpaceCategories()

MAXON_METHOD Result<BaseArray<CString> > GetColorSpaceCategories

(

const CString &

colorSpaceName

)

const

GetRenderingColorSpaceNames()

MAXON_METHOD Result<BaseArray<CString> > GetRenderingColorSpaceNames

(

)

const

GetDisplays()

MAXON_METHOD Result<BaseArray<Display> > GetDisplays

(

Bool

activeOnly

)

const

GetViewTransformNames()

MAXON_METHOD Result<BaseArray<CString> > GetViewTransformNames

(

const CString &

displayColorSpaceName

)

const

GetColorSpaceName()

MAXON_METHOD const CString& GetColorSpaceName

(

COLORSPACE_NAME

name

)

const

GetDefaultDisplayName()

MAXON_METHOD const CString& GetDefaultDisplayName

(

)

const

GetLutLocations()

MAXON_METHOD const BaseArray<CString>& GetLutLocations

(

)

const

GetMonitorNames()

MAXON_METHOD const BaseArray<CString>& GetMonitorNames

(

)

const

GetColorspaceNameForFile()

MAXON_METHOD Result<CString> GetColorspaceNameForFile

(

const Url &

path

)

const

GetMonitorColorSpaceName()

MAXON_METHOD const CString& GetMonitorColorSpaceName

(

UInt64

monitorSystemHandle

)

const

SetDisallowFileRules()

MAXON_METHOD void SetDisallowFileRules

(

Bool

value = true

)

DescribeIO()

static MAXON_METHOD Result<void> DescribeIO ( const DataSerializeInterface &  stream )

staticprivate

Member Data Documentation

MAXON_ENUM_LIST_CLASS

struct maxon::OcioConfigInterface::Display MAXON_ENUM_LIST_CLASS