SE RearrangeImageData

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

extern SE_Status_Code
SE_RearrangeImageData
(
const	SE_Image_Fields	*	image_fields_ptr,	¹
const	SE_Image_Data	*	data_in_ptr,	²
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

Used by SE_GetRearrangedImageData() to rearrange the image data as specified by the SE_Desired_Image_Parameters structure. It is exposed to the user so that image data previously obtained by a call to SE_GetRearrangedImageData() or SE_GetImageData() (or even user-created image data) can be rearranged without a new call to the functions mentioned above.

This function requires information about how the image data passed in is arranged. Consequently, the user must fill and pass in an appropriate structure by either an explicit allocation or by obtaining one from an <Image> object (this last is what the function SE_GetRearrangedImageData does).

This function only rearranges the specified mip_level.

Returns

SE_STATCODE_SUCCESS	and the appropriate values are placed in *data_out_ptr, if valid parameters were passed in.
SE_STATCODE_INACTIONABLE_FAILURE	and *data_out_ptr is not affected, if image_fields_ptr is invalid, if any start or stop texels were invalid for image_fields_ptr, desired_image_parameters_ptr is invalid, the source image signature (in image_fields_ptr) is invalid, or if the requested image is a floating-point image in which one of the texel components is computed to be neither SE_Float nor SE_Long_Float

Parameters Notes

¹ the fields of the <Image> whose data is pointed to by data_in_ptr; this structure describes how the data pointed to by the the data_in_ptr is organized.

² the source image data (possibly obtained from SE_GetImageData()); a pointer to a block of memory, already allocated in the user's memory space, which contain the image data to be rearranged. This memory space is entirely under the user's control. The only time the API accesses this memory is when the API reads the image data during this function call.

³ 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 the image data that was passed in.

⁷ the results; a pointer to a block of memory, 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 that the API accesses this memory is when the API copies data into the memory during this function call.