DG Kernel Documentation


Skip Navigation Links.
Skip Navigation LinksHome Page > API Reference > General Computing > IKCContext2 Search Documentation


IKCContext2 Interface

GetColorParam
SetColorParam

Manages extended types of parameters of a context. IKCContext2 can be queried from the relevant IKCContext.

See also IKCContext, Interface List


HRESULT GetColorParam(int id, float* red, float* green, float* blue, float* alpha)

Parameters

id - [in] 0-based index in array of color parameters of the context

red, green, blue, alpha - [out] The returned color

Remarks:

Returns id-th color parameter in the context. The method fails if id is greater or equal to the count retuned by IKCContext.GetParamCount(EKCType.eKCTypeColor, count). Where IKCContext is the interface this IKCContext2 was queried from.


HRESULT SetColorParam(int id, float red, float green, float blue, float alpha)

Parameters

id - [in] 0-based index in array of color parameters of the context

red, green, blue, alpha - [in] New value of color

Remarks:

Modifies id-th color parameter in the context. The method fails if id is greater or equal to the count retuned by IKCContext.GetParamCount(EKCType.eKCTypeColor, count). Where IKCContext is the interface this IKCContext2 was queried from.