formZ SDK | 5.0 API Reference | System | Data Type

fz_type_get_rgb_uchar

Description

This function performs the following data type conversions:
Variant Type Conversion
fz_xyz_td x value multiplied by 255.0 and copied to red, y value multiplied by 255.0 and copied to green, z value multiplied by 255.0 and copied to blue, loss of precision. Values clamped to range of 0 to 255.
fz_xyzw_td x value multiplied by 255.0 and copied to red, y value multiplied by 255.0 and copied to green, z value multiplied by 255.0 and copied to blue, w lost, loss of precision. Values clamped to range of 0 to 255.
fz_xyz_float_td x value multiplied by 255.0 and copied to red, y value multiplied by 255.0 and copied to green, z value multiplied by 255.0 and copied to blue, loss of precision. Values clamped to range of 0 to 255.
fz_rgb_ushort_td values scaled from 0 to 65535 to 0 to 255, loss of precision.
fz_rgb_float_td values multiplied by 255 and converted to integer, loss of precision.

Plugin Prototype

fzrt_error_td fz_type_get_rgb_uchar(

fz_type_ptr

type,

fz_rgb_uchar_td *

ucrgb )

Parameters

type [Input]

A pointer to a variant

ucrgb [Result]

A pointer to a color to be filled. Must be allocated by the caller.

Availability

5.0.0.0

See Also

, , fz_type_get_rgb_float,

Function Set

fz_type_fset


Defined in

fz_type_api.h