SE ValidImageExtents

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

extern SE_Boolean
SE_ValidImageExtents
(
const	SE_Image_Fields	*	fields_ptr,	(notes)
	SE_Integer_Unsigned		start_texel_horizontal,
	SE_Integer_Unsigned		start_texel_vertical,
	SE_Integer_Unsigned		start_texel_z,	(notes)
	SE_Integer_Unsigned		stop_texel_horizontal,
	SE_Integer_Unsigned		stop_texel_vertical,
	SE_Integer_Unsigned		stop_texel_z,	(notes)
	SE_Short_Integer_Unsigned		mip_level	(notes)
);

Definition

Checks whether the specified extents are valid for the given <Image>.

Returns

SE_TRUE if all parameters are valid.

SE_FALSE if

fields_ptr is NULL

fields_ptr->level_count is zero

fields_ptr->mip_extents_array is NULL

mip_level is greater than or equal to fields_ptr->level_count

start_texel_horizontal >= fields_ptr->mip_extents_array[mip_level].size_horizontal, or start_texel_horizontal > stop_texel_horizontal

start_texel_vertical >= fields_ptr->mip_extents_array[mip_level].size_vertical, or start_texel_vertical > stop_texel_vertical

if fields_ptr->data_is_3D is SE_TRUE, whether start_texel_z >= fields_ptr->mip_extents_array[mip_level].size_z or start_texel_z > stop_texel_z

Parameters Notes

fields_ptr

 fields for the <Image> for which the extents are being
    checked.

start_texel_z

 the starting extents being requested.

stop_texel_z

 the stopping extents being requested.

mip_level

 the mip_level being requested for the given <Image>.