L_ClrInit

Summary

Initializes the color conversion engine.

Syntax

#include "ltkrn.h"
#include "ltclr.h"

L_LTCLR_API L_INT L_ClrInit(pClrHandle, nSrcFormat, nDstFormat, pParams)

Parameters

L_HANDLE *pClrHandle

Pointer to a color conversion handle. This handle is needed in the conversion process and for setting the process options.

L_INT nSrcFormat

Format of the source data. Possible values are:

L_INT nDstFormat

Format of the output data. Possible values are:

LPCONVERSION_PARAMS pParams

Pointer to a CONVERSION_PARAMS structure that contains the conversion properties used in the initialization.

Returns

Comments

L_ClrInit must be called before calling any other LEADTOOLS Color Space toolkit functions in case of indirect conversion.

When the handle to the color conversion is no longer needed, it should be freed by calling L_ClrFree. For every call to L_ClrInit there must be a call to L_ClrFree.

If pParams is NULL, the default built in conversion is assumed, and any subsequent calls to L_ClrSetConversionParams will only affect CMYK conversion parameters.

When you choose the conversion method, be sure not to combine the Profiles option (USE_ICC) with the Custom Profiles option (USE_CUSTOM_ICC), or the Emulation Tables method (USE_ET) with the custom Emulation Tables method (USE_CUSTOM_ET).

Supports conversion using ICC Devicelink profiles with option (USE_CUSTOM_ICC) and using it as input profile.

Platforms

Win32, x64.

Required DLLs and Libraries

• LTCLR
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

See Also

Functions

• L_ClrConvert
• L_ClrFree

Topics

• Initializing a Color Conversion Handle
• Color Conversion C API Function Groups

Example

L_INT ClrInitExample( 
   L_UCHAR* pInput, 
   L_INT nWidth, 
   L_INT nHeight) 
{ 
   L_INT nRet; 
 
   HANDLE ClrHandle; /* Conversion color handle */ 
 
   CONVERSION_PARAMS params = { sizeof(CONVERSION_PARAMS) }; 
   params.nActiveMethod = USE_AUTO; 
   params.nMethod = USE_AUTO; 
   params.nQuantization = 8; 
 
   /* Initialize the color conversion to use the simplest conversion 
      that gives good results for all conversions. 
      The USE_AUTO method uses the built-in ICC profiles to do the CMYK->RGB conversion. 
      Other conversions might use built-in conversion formulas. 
   */ 
   nRet = L_ClrInit(&ClrHandle, CCS_CMYK, CCS_RGB, &params); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* convert the image buffer */ 
   nRet = L_ClrConvert(ClrHandle, /* conversion handle */ 
      pInput,     /* input buffer */ 
      pInput,     /* output buffer */ 
      nWidth,     /* pixels width */ 
      nHeight,    /* pixels height */ 
      0,          /* 0 bytes align */ 
      0);         /* 0 bytes align */ 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* free the conversion */ 
   nRet = L_ClrFree(ClrHandle); 
 
   return nRet; 
}