|
Synergy Color Management Component - SDK -
2018.0.80
|
Color transform class. More...
Classes | |
| class | ContentCallbacks |
| Callback class for extracting color transform metadata. More... | |
Public Member Functions | |
| virtual | ~Transform () |
| Destructor. More... | |
| virtual SYNCOLOR::TransformPtr | clone () const =0 |
| Clone the Transform. More... | |
| virtual const char * | getId () const =0 |
| Color transform ID. More... | |
| virtual SynStatus | setId (const char *id)=0 |
| Set the color transform ID. More... | |
| virtual const char * | getUniqueId () const =0 |
| Transform unique ID. More... | |
| virtual SynStatus | setUniqueId (const char *id)=0 |
| Set the unique transform ID. More... | |
| virtual const char * | getName () const =0 |
| Transform name. More... | |
| virtual void | setName (const char *name)=0 |
| Set the color transform name. More... | |
| virtual const char * | getDescriptions () const =0 |
| Color transform description. More... | |
| virtual void | setDescription (const char *description)=0 |
| Set the transform description. More... | |
| virtual const char * | getInputDescriptor () const =0 |
| Color transform input description. More... | |
| virtual void | setInputDescriptor (const char *inDesc)=0 |
| Set the transform input description. More... | |
| virtual const char * | getOutputDescriptor () const =0 |
| Color transform output description. More... | |
| virtual void | setOutputDescriptor (const char *outDesc)=0 |
| Set the transform output description. More... | |
| virtual SYNCOLOR::BitDepth | getInputBitDepth () const =0 |
| Transform input bit depth. More... | |
| virtual SYNCOLOR::BitDepth | getOutputBitDepth () const =0 |
| Transform output bit depth. More... | |
| virtual SYNCOLOR::PixelFormat | getInputPixelFormat () const =0 |
| Transform input pixel format. More... | |
| virtual SYNCOLOR::SynStatus | setInputPixelFormat (SYNCOLOR::PixelFormat pf)=0 |
| Set the transform input pixel format. More... | |
| virtual SYNCOLOR::PixelFormat | getOutputPixelFormat () const =0 |
| Transform ouutput pixel format. More... | |
| virtual SYNCOLOR::SynStatus | setOutputPixelFormat (SYNCOLOR::PixelFormat pf)=0 |
| Set the transform output pixel format. More... | |
| virtual SYNCOLOR::SynStatus | setPixelFormats (SYNCOLOR::PixelFormat inPF, SYNCOLOR::PixelFormat outPF)=0 |
| Set both the input and the output pixel format. More... | |
| virtual SYNCOLOR::SynStatus | inverse (SYNCOLOR::TransformPtr &t) const =0 |
| Create the inverse transform. More... | |
| virtual bool | isInverseOf (const SYNCOLOR::TransformPtr &t) const =0 |
| Checks if a transform is the inverse of this instance. More... | |
| virtual bool | hasReferences () const =0 |
| Checks if this transform has references to resolve. More... | |
| virtual bool | hasAliasReferencesToResolve () const =0 |
| Checks if this transform has aliases to resolve. More... | |
| virtual void | extractContent (ContentCallbacks &callbacks) const =0 |
| Color transform metadata extraction. More... | |
| virtual SynStatus | setDynamicProperty (const DynamicProperty &prop)=0 |
| Set the value of a dynamic property. More... | |
| virtual SynStatus | getDynamicProperty (DynamicProperty &prop)=0 |
| Obtain a dynamic property value. More... | |
| virtual const GPUAdaptorPtr & | getGPUAdaptor () const =0 |
| Set the GPU Adaptor. More... | |
| virtual SynStatus | applyCPU (const void *srcBuf, const ROI &roi, void *dstBuf)=0 |
| Render the color transform to a memory buffer using the CPU renderer. You must call finalize on the transform before calling apply! More... | |
| virtual SynStatus | applyCPU (const void *srcBuf, unsigned srcRowSize, const ROI &roi, void *dstBuf, unsigned dstRowSize)=0 |
| Render the color transform to a padded memory buffer using the CPU renderer. You must call finalize on the transform before calling apply! More... | |
| virtual void | applyCPUSinglePixel (const void *srcBuf, void *dstBuf, unsigned x, unsigned y)=0 |
| Render the color transform for a single pixel using the CPU renderer. You must call finalize on the transform before calling apply! More... | |
| virtual SynStatus | applyGPU (unsigned inTexHandle, const SYNCOLOR::Vertices &texCoords, const SYNCOLOR::Vertices &screenCoords) const =0 |
| Render the color transform to the active render destination using the GPU renderer. You must call finalize on the transform before calling apply! More... | |
Color transform class.
A color transform is a sequence of color operators to be applied to pixel values. Each operator can be one of many different types: a matrix, a 1-d LUT, a 3-d LUT, a gamma, and more. For more details on the structure of color transforms and for a list of color operators see the Autodesk Color Management Guide included with this SDK.
|
virtual |
Destructor.
|
pure virtual |
Clone the Transform.
|
pure virtual |
Color transform ID.
If the transform is read from a CTF file, the id can found in the XML description.
|
pure virtual |
Set the color transform ID.
| id | New transform ID. |
|
pure virtual |
Transform unique ID.
This ID is different from the color transform ID above. It is used by the transform caching system.
|
pure virtual |
Set the unique transform ID.
This method is used by the transform caching system and should not be used.
| id | New unique transform ID. |
|
pure virtual |
Transform name.
This name is an optional attribute of the xml description in CTF files. The name empty string when not specified.
|
pure virtual |
Set the color transform name.
| name | New transform name. |
|
pure virtual |
Color transform description.
The description is an optional segment of the CTF file. If more than one description entry is present in the file, the entries are separated by newlines in the returned string.
|
pure virtual |
Set the transform description.
| description | New transform description. |
|
pure virtual |
Color transform input description.
This description is an optional element of the CTF file. If the description is not specified, the empty string is returned.
|
pure virtual |
Set the transform input description.
| inDesc | New input descriptor. |
|
pure virtual |
Color transform output description.
This description is an optional element of the CTF file. If the description is not specified, the empty string is returned.
|
pure virtual |
Set the transform output description.
| outDesc | New output descriptor. |
|
pure virtual |
Transform input bit depth.
|
pure virtual |
Transform output bit depth.
|
pure virtual |
Transform input pixel format.
|
pure virtual |
Set the transform input pixel format.
| pf | New input pixel format. |
|
pure virtual |
Transform ouutput pixel format.
|
pure virtual |
Set the transform output pixel format.
| pf | New output pixel format. |
|
pure virtual |
Set both the input and the output pixel format.
| inPF | New input pixel format |
| outPF | New output pixel format |
|
pure virtual |
Create the inverse transform.
| t | Return TransformPtr containing the inverse. |
|
pure virtual |
Checks if a transform is the inverse of this instance.
With the help of the transform IDs, this method determines whether a transform is the inverse of this one. This method is useful only if the two transforms originate from CTF files in the Autodesk color transform collection.
| t | Transform to check against. |
|
pure virtual |
Checks if this transform has references to resolve.
|
pure virtual |
Checks if this transform has aliases to resolve.
|
pure virtual |
Color transform metadata extraction.
| callbacks | Metadata extraction callback class implementation instance. |
|
pure virtual |
Set the value of a dynamic property.
| prop | Property description. |
|
pure virtual |
Obtain a dynamic property value.
This method puts the return value in the value union based on the type provided in the DynamicProperty.
| prop | Property instance. |
|
pure virtual |
Set the GPU Adaptor.
If GPU rendering is needed, an adaptor must be supplied to the color transform prior to the call to SYNCOLOR::finalize.
Obtain the GPUAdaptor used by the transform..
|
pure virtual |
Render the color transform to a memory buffer using the CPU renderer. You must call finalize on the transform before calling apply!
| srcBuf | Memory area with the image to process. Must be of the appropriate input pixel format. |
| roi | Region of interest (ROI) to apply the transform to. |
| dstBuf | Memory area to write the transformed pixel values to. Must be of the appropriate output pixel format. |
|
pure virtual |
Render the color transform to a padded memory buffer using the CPU renderer. You must call finalize on the transform before calling apply!
This version of applyCPU provides parameters to deal with images in padded memory buffers.
| srcBuf | Memory area with the image to process. Must be of the appropriate input pixel format. |
| srcRowSize | Source image row size in bytes. |
| roi | Region of interest (ROI) to apply the transform to. |
| dstBuf | Memory area to write the transformed pixel values to. Must be of the appropriate output pixel format. |
| dstRowSize | Destination image row size in bytes. |
|
pure virtual |
Render the color transform for a single pixel using the CPU renderer. You must call finalize on the transform before calling apply!
| srcBuf | Pointer to the pixel to process. Must be of the appropriate input pixel format. |
| dstBuf | Pointer for where to put the output pixel value to. Must be of the appropriate output pixel format. |
| x | is the column coordinate of the pixel location |
| y | is the row coordinate of the pixel location |
|
pure virtual |
Render the color transform to the active render destination using the GPU renderer. You must call finalize on the transform before calling apply!
Using the GPUAdaptor::drawQuad method, the color transform is applied to the input texture specified and rendered into the active rendering destination.
| inTexHandle | Handle to the texture to process. |
| texCoords | Input texture coordinates. |
| screenCoords | Destination coordinates. |