SE GetRearrangedImageData

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

extern SE_Status_Code
SE_GetRearrangedImageData
(
	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,	⁴
const	SE_Desired_Image_Parameters	*	desired_image_parameters_ptr,	⁵
	SE_Image_Data	*	data_out_ptr	⁶
);

Definition

Copy (rearranging and sampling as necessary) the selected texels from the selected area of interest of the given Image into a space in memory that the user has already allocated to hold this data.

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.

NOTE: The first 8 parameters are identical to those of the Level 0 Read API SE_GetImageData() function.

Returns

SE_STATCODE_SUCCESS	and image's texels are retrieved and copied into data_out_ptr in the specified manner, if valid parameters were passed in and all operations succeeded. (The original texels of image itself are unaffected.)
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	and *data_out_ptr is left unaltered, if image is unresolved.
SE_STATCODE_INACTIONABLE_FAILURE	*data_out_ptr is not affected, if no image data has yet been specified for image, 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, or any start or stop texels were invalid for image, or desired_image_parameters_ptr is invalid, the size of the mip_level of image cannot be computed the texels of image cannot be retrieved, the byte_count is not correct for the given extents and the texels of image.

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 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_GetImageData() call).

⁵ a pointer to a structure containing the "rearranging" parameters that the user must supply to rearrange the data of the <Image> instance which was passed in.

⁶ a pointer to a structure, already allocated in the user's memory space, which will be filled by this function with the appropriate values. This memory space is entirely under the user's control. The only time the API accesses this memory is when the API copies data into the memory during this function call.