SE GetSizeOfImageData

SEDRIS Reference Manual APPENDIX B - Transmittal Access Level 1 API Functions SE GetSizeOfImageData

extern SE_Status_Code
SE_GetSizeOfImageData
(
	SE_Object		image,	¹
const	SE_Image_Texel_Location_3D	*	start_texel,	²
const	SE_Image_Texel_Location_3D	*	stop_texel,	³
	SE_Short_Integer_Unsigned		mip_level,	⁴
	SE_Integer_Unsigned	*	byte_count_out_ptr	⁵
);

Definition

Computes the number of bytes needed in order to store a sub-image of the given texel extents.

This function can be used to determine how much space to allocate for a call to the level 0 API function SE_GetImageData().

An <Image> is a set of 2 or 3 dimensional collections of texel values. The number of MIP levels for the <Image> defines the number of 2 or 3 dimensional collections in the image. The definition of the <Image> will define the number of texels in each MIP level and the number of bits (not just bytes, but bits) for each texel.

Returns

SE_STATCODE_SUCCESS	and *byte_count_out_ptr is set to the appropriate value, if valid parameters were passed in.
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	and *byte_count_out_ptr is set to zero (0), if image is unresolved.
SE_STATCODE_INACTIONABLE_FAILURE	and *byte_count_out_ptr is set to zero (0), if level_count or mip_extents_array are NULL in image, image's fields are otherwise invalid or cannot be retrieved, mip_level is out of range for image, any start or stop texels were invalid for image, or the call fails for any other reason.

Parameters Notes

¹ the <Image> instance

² the starting texel index of the <Image> instance data to be retrieved; must be less than or equal to stop_texel, and must be valid for the specified MIP level of image.

³ the stopping texel index of the <Image> instance data to be retrieved; must be greater than or equal to start_texel, and must be valid for the specified MIP level of image.

⁴ the MIP level of the <Image> from which the data size will be returned. Each <Image> has at least one MIP level. Many <Image>s have multiple MIP levels. Data can only be retrieved from one mip level at a time (only one MIP level per SE_GetSizeOfImageData() call).

⁵ a pointer to the variable in the user's memory space where the number of bytes needed to store the specified sub-image will be stored.