HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::BuiltinConfigRegistry Class Referenceabstract

#include <OpenColorIO.h>

Public Member Functions

 BuiltinConfigRegistry (const BuiltinConfigRegistry &)=delete
 
BuiltinConfigRegistryoperator= (const BuiltinConfigRegistry &)=delete
 
virtual size_t getNumBuiltinConfigs () const noexcept=0
 Get the number of built-in configs available. More...
 
virtual const char * getBuiltinConfigName (size_t configIndex) const =0
 
virtual const char * getBuiltinConfigUIName (size_t configIndex) const =0
 Throws for illegal index. More...
 
virtual const char * getBuiltinConfig (size_t configIndex) const =0
 
virtual const char * getBuiltinConfigByName (const char *configName) const =0
 
virtual bool isBuiltinConfigRecommended (size_t configIndex) const =0
 Check if a specific built-in config is recommended. More...
 
virtual const char * getDefaultBuiltinConfigName () const =0
 

Static Public Member Functions

static const
BuiltinConfigRegistry
Get () noexcept
 Get the current built-in configs registry. More...
 

Protected Member Functions

 BuiltinConfigRegistry ()=default
 
virtual ~BuiltinConfigRegistry ()=default
 

Detailed Description

The built-in configs registry contains information about all the existing built-in configs.

Definition at line 3731 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::BuiltinConfigRegistry::BuiltinConfigRegistry ( const BuiltinConfigRegistry )
delete
OCIO_NAMESPACE::BuiltinConfigRegistry::BuiltinConfigRegistry ( )
protecteddefault
virtual OCIO_NAMESPACE::BuiltinConfigRegistry::~BuiltinConfigRegistry ( )
protectedvirtualdefault

Member Function Documentation

static const BuiltinConfigRegistry& OCIO_NAMESPACE::BuiltinConfigRegistry::Get ( )
staticnoexcept

Get the current built-in configs registry.

virtual const char* OCIO_NAMESPACE::BuiltinConfigRegistry::getBuiltinConfig ( size_t  configIndex) const
pure virtual

Get Yaml text of the built-in config at the specified index. Throws for illegal index.

virtual const char* OCIO_NAMESPACE::BuiltinConfigRegistry::getBuiltinConfigByName ( const char *  configName) const
pure virtual

Get the Yaml text of the built-in config with the specified name. Throws if the name is not found.

virtual const char* OCIO_NAMESPACE::BuiltinConfigRegistry::getBuiltinConfigName ( size_t  configIndex) const
pure virtual

Get the name of the config at the specified (zero-based) index. Throws for illegal index.

virtual const char* OCIO_NAMESPACE::BuiltinConfigRegistry::getBuiltinConfigUIName ( size_t  configIndex) const
pure virtual

Throws for illegal index.

virtual const char* OCIO_NAMESPACE::BuiltinConfigRegistry::getDefaultBuiltinConfigName ( ) const
pure virtual
virtual size_t OCIO_NAMESPACE::BuiltinConfigRegistry::getNumBuiltinConfigs ( ) const
pure virtualnoexcept

Get the number of built-in configs available.

virtual bool OCIO_NAMESPACE::BuiltinConfigRegistry::isBuiltinConfigRecommended ( size_t  configIndex) const
pure virtual

Check if a specific built-in config is recommended.

For backwards compatibility reasons, configs will remain in the registry even if they have been superseded. If an app is presenting a list of configs to users, it should not include configs that are no longer recommended.

Throws if the name is not found.

Parameters
configIndexIndex of built-in config.
Returns
true if the config is recommended.
BuiltinConfigRegistry& OCIO_NAMESPACE::BuiltinConfigRegistry::operator= ( const BuiltinConfigRegistry )
delete

The documentation for this class was generated from the following file: