View source for Colormapping (lx-colormapping.hpp)

{{DISPLAYTITLE:colormapping (lx_colormapping.hpp)}}

<span id="S1"></span>
== ColorMapping ==

This module provides interfaces for handling color conversion and selecting color profiles.
<span id="C1"></span>
<span id="S1.1"></span>
=== Defining Entries ===

ColorMapping, specifies an object used for color conversion between linear and a particular colorspace.

===== (1) SDK: LXu_COLORMAPPING, etc. defines =====

<syntaxhighlight>
 #define [[LXu_COLORMAPPING (index)|LXu_COLORMAPPING]]        "40D65C4F-D394-40E2-A71A-B174E971F462"
 #define [[LXa_COLORMAPPING (index)|LXa_COLORMAPPING]]        "colormapping" 
 #define CMS_GPU_LUT3D_EDGE_SIZE 32
</syntaxhighlight>

<span id="C2"></span>
===== (2) SDK: ColorMapping::Setup =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Setup) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         int                             toLinear);
</syntaxhighlight>

<span id="C3"></span>
===== (3) SDK: ColorMapping::ToLinear =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 ToLinear) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         const [[LXtFVector (index)|LXtFVector]]        sourceValues,
         [[LXtFVector (index)|LXtFVector]]                      linearValues,
         unsigned int            length);
</syntaxhighlight>

<span id="C4"></span>
===== (4) SDK: ColorMapping::FromLinear =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 FromLinear) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         const [[LXtFVector (index)|LXtFVector]]        linearValues,
         [[LXtFVector (index)|LXtFVector]]                      targetValues,
         unsigned int            length);
</syntaxhighlight>

<span id="C5"></span>
===== (5) SDK: ColorMapping::ToLinearFast =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 ToLinearFast) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         float*                          buf,
         unsigned int            length);
</syntaxhighlight>

<span id="C6"></span>
===== (6) SDK: ColorMapping::FromLinearFast =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 FromLinearFast) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         float*                          buf,
         unsigned int            length);
</syntaxhighlight>

<span id="C7"></span>
===== (7) SDK: ColorMapping::GetLUTImage =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 GetLUTImage) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         float                      **ptr);
</syntaxhighlight>

<span id="C8"></span>
===== (8) SDK: ColorMapping::GetShaderSource =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 GetShaderSource) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         char                       **ptr);
</syntaxhighlight>

<span id="C9"></span>
===== (9) SDK: ColorMapping::GetName =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( const char*,
 GetName) (
         [[LXtObjectID (index)|LXtObjectID]]                     self);
</syntaxhighlight>

<span id="C10"></span>
Empty ColorMapping Python user class.

===== (10) PY: empty ColorMapping user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

<span id="C11"></span>
<span id="S2"></span>
== ILxColorMappingService ==

The color mapping service allows color mapping items to be enumerated and created.

===== (11) SDK: LXu_COLORMAPPINGSERVICE, etc. defines =====

<syntaxhighlight>
 #define [[LXu_COLORMAPPINGSERVICE (index)|LXu_COLORMAPPINGSERVICE]] "c3e44fbc-45c6-47b5-aaee-f0cc002dd474"
 #define [[LXa_COLORMAPPINGSERVICE (index)|LXa_COLORMAPPINGSERVICE]] "colormappingservice"
 // don't need export or local for services, as it's done automatically</syntaxhighlight>

<span id="C12"></span>
===== (12) SDK: ColorMappingService::MakeColorMapping =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 MakeColorMapping) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         const char              *colorspaceName,
         int                      toLinear,
         void                   **ppvObj);
</syntaxhighlight>

<span id="C13"></span>
===== (13) SDK: ColorMappingService::ConfigCount =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( int,
 ConfigCount) (
         [[LXtObjectID (index)|LXtObjectID]]                     self);
</syntaxhighlight>

<span id="C14"></span>
===== (14) SDK: ColorMappingService::ConfigName =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 ConfigName) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         int                                     index,
         const char                      **configName);
</syntaxhighlight>

<span id="C15"></span>
===== (15) SDK: ColorMappingService::ConfigFullPath =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 ConfigFullPath) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         int                                     index,
         const char                      **configPath);
</syntaxhighlight>

<span id="C16"></span>
===== (16) SDK: ColorMappingService::RegisterColorspaceForConfig =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 RegisterColorspaceForConfig) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         const char                      *configName,
         const char                      *colorspaceName);
</syntaxhighlight>

<span id="C17"></span>
Get the color mapping used for displaying colors in the interface.

===== (17) SDK: ColorMappingService::GetDisplayColorMapping =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 GetDisplayColorMapping) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         void                            **ppvObj);
</syntaxhighlight>

<span id="C18"></span>
Get the color mapping used for numeric values in the interface.

===== (18) SDK: ColorMappingService::GetNumericColorMapping =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 GetNumericColorMapping) (
         [[LXtObjectID (index)|LXtObjectID]]                     self,
         void                            **ppvObj);
</syntaxhighlight>

<span id="C19"></span>
Empty ColorMapping service user classes.

===== (19) SDK: empty ColorMappingService User Class =====

<span id="C20"></span>
===== (20) PY: empty Service.ColorMapping user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

[[Category:Headers]]
[[Category:Autogenerated]]