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

#include <OpenColorIO.h>

Public Member Functions

 ConfigIOProxy ()=default
 
virtual ~ConfigIOProxy ()=default
 
virtual std::vector< uint8_t > getLutData (const char *filepath) const =0
 Provide the contents of a LUT file as a buffer of uint8_t data. More...
 
virtual std::string getConfigData () const =0
 Provide the config file Yaml to be parsed. More...
 
virtual std::string getFastLutFileHash (const char *filepath) const =0
 Provide a fast unique ID for a LUT file. More...
 

Detailed Description

ConfigIOProxy is a proxy class to allow the calling program to supply the config and any associated LUT files directly, without relying on the standard file system.

The OCIOZ archive feature is implemented using this mechanism.

Definition at line 3687 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::ConfigIOProxy::ConfigIOProxy ( )
default
virtual OCIO_NAMESPACE::ConfigIOProxy::~ConfigIOProxy ( )
virtualdefault

Member Function Documentation

virtual std::string OCIO_NAMESPACE::ConfigIOProxy::getConfigData ( ) const
pure virtual

Provide the config file Yaml to be parsed.

Returns
String with the config Yaml.
virtual std::string OCIO_NAMESPACE::ConfigIOProxy::getFastLutFileHash ( const char *  filepath) const
pure virtual

Provide a fast unique ID for a LUT file.

This is intended to supply the string that will be used in OCIO's FileCacheMap. This should be highly performant and typically should not require extensive computation such as calculating the md5 hash of the file, unless it is pre-computed.

If the "file" does not exist, in other words, if the proxy is unable to supply the requested file contents, the function must return an empty string.

Parameters
filepathFully resolve the path to the "file."

The file path is based on the Config's current working directory and is the same absolute path that would have been provided to the file system.

Returns
The file hash string.
virtual std::vector<uint8_t> OCIO_NAMESPACE::ConfigIOProxy::getLutData ( const char *  filepath) const
pure virtual

Provide the contents of a LUT file as a buffer of uint8_t data.

Parameters
filepathFully resolved path to the "file."

The file path is based on the Config's current working directory and is the same absolute path that would have been provided to the file system.

Returns
Vector of uint8 with the content of the LUT.

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