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_STAT_CODE_SUCCESS	and *byte_count_out_ptr is set to the appropriate value, if valid parameters were passed in.
SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT	and *byte_count_out_ptr is set to zero (0), if image is unresolved.
SE_STAT_CODE_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

image

 the <Image> instance

start_texel_horizontal

 the starting texel index (horizontal) of the
    <Image> data to be retrieved; must be less than or equal to
    stop_texel_horizontal, and must be valid for the specified MIP level
    of the <Image>.

start_texel_vertical

 the starting texel index (vertical) of the
    <Image> data to be retrieved; must be less than or equal to
    stop_texel_vertical, and must be valid for the specified MIP level
    of the <Image>.

start_texel_z

 the starting texel index (z) of the <Image> data to be
    retrieved; must be less than or equal to stop_texel_z. For a 2-D
    <Image>, start_texel_z will be ignored; otherwise, it must be valid for
    the specified MIP level of the <Image>.

stop_texel_horizontal

 the stopping texel index (horizontal) of the
    <Image> data to be retrieved; must be greater than or equal to
    start_texel_horizontal, and must be valid for the specified MIP level
    of the <Image>.

stop_texel_vertical

 the stopping texel index (vertical) of the
    <Image> data to be retrieved; must be greater than or equal to
    start_texel_vertical, and must be valid for the specified MIP level
    of the <Image>.

stop_texel_z

 the stopping texel index (z) of the <Image> data to be
    retrieved; must be greater than or equal to start_texel_z. For a 2-D
    <Image>, stop_texel_z will be ignored; otherwise, it must be valid for
    the specified MIP level of the <Image>.

mip_level

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

byte_count_out_ptr

 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.

Prev: SE_GetRearrangedImageData. Next: SE_ImageNameFromImageMappingFunction. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™