formZ SDK | 5.0 API Reference | System | Data Type

# fz_type_get_xyz

Description

This function performs the following data type conversions:
Variant Type Conversion
fz_xy_td x & y values copied, z set to 0.0, no data lost.
fz_xyzw_td x, y & z values copied, w lost.
fz_xy_float_td x & y values copied, z set to 0.0, no data lost.
fz_xyz_float_td x, y & z values copied, no data lost.
fz_rgb_uchar_td red value divided by 255.0 and copied to x,
green value divided by 255.0 and copied to y,
blue value divided by 255.0 and copied to z, no data lost.
fz_rgb_ushort_td red value divided by 65535.0 and copied to x,
green value divided by 65535.0 and copied to y,
blue value divided by 65535.0 and copied to z, no data lost.
fz_rgb_float_td red value copied to x,
green value copied to y,
blue value copied to z, no data lost.

Plugin Prototype

fzrt_error_td fz_type_get_xyz(

fz_type_ptr | type,
fz_xyz_td * | xyz )

Parameters

type [Input]

A pointer to a variant

xyz [Result]

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

Availability

5.0.0.0

See Also

fz_type_set_xyz, , fz_type_get_xyz_float, fz_type_get_xyz_float_ptr

Function Set

fz_type_fset

Defined in

fz_type_api.h