SE BitsPerTexel

SEDRIS Reference Manual APPENDIX C - LEVEL 0 READ and WRITE API AUXILIARY FUNCTIONS Functions SE BitsPerTexel

extern SE_Status_Code
SE_BitsPerTexel
(
const	SE_Image_Fields	*	image_fields_ptr,	(notes)
	SE_Integer_Unsigned	*	result_out_ptr	(notes)
);

Definition

Computes how many bits per texel are required for the <Image> that corresponds to the given fields.

Returns

SE_STAT_CODE_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes are made, if image_fields_ptr or result_out_ptr is NULL.

SE_STAT_CODE_FAILURE and *result_out_ptr is set to zero (0), if *image_fields_ptr does not correspond to a valid <Image> instance.

Parameters Notes

image_fields_ptr

 pointer to the SE_Image_Fields being evaluated

result_out_ptr

 bits per texel for the given fields

SE_STAT_CODE_SUCCESS	and *result_out_ptr is set appropriately, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes are made, if image_fields_ptr or result_out_ptr is NULL.
SE_STAT_CODE_FAILURE	and result_out_ptr is set to zero (0), if image_fields_ptr does not correspond to a valid <Image> instance.