Grok 20.3.2
grk_wait_swath Struct Reference

Specify swath region to wait on during asynchronous decompression. More...

#include <grok.h>

Public Attributes

uint32_t x0
 Input: Pixel coordinate: top-left x.
uint32_t y0
 Input: Pixel coordinate: top-left y.
uint32_t x1
 Input: Pixel coordinate: bottom-right x (exclusive).
uint32_t y1
 Input: Pixel coordinate: bottom-right y (exclusive).
uint16_t tile_x0
 Output: Global tile column start (inclusive).
uint16_t tile_y0
 Output: Global tile row start (inclusive).
uint16_t tile_x1
 Output: Global tile column end (exclusive).
uint16_t tile_y1
 Output: Global tile row end (exclusive).
uint16_t num_tile_cols
 Output: Total tile columns in the image tile grid.

Detailed Description

Specify swath region to wait on during asynchronous decompression.

Input: Set pixel coordinates (x0, y0, x1, y1) before calling grk_decompress_wait(). Output: After grk_decompress_wait() returns, tile_x0/y0/x1/y1 and num_tile_cols are populated with the tile grid indices covering the requested swath. These can be used with grk_decompress_get_tile_image() to retrieve per-tile decoded data.

Note: tile coordinates are only populated when grk_decompress_wait() is called with a non-null swath pointer and asynchronous+simulate_synchronous mode is enabled.

Member Data Documentation

◆ num_tile_cols

uint16_t grk_wait_swath::num_tile_cols

Output: Total tile columns in the image tile grid.

Referenced by grk::CodeStreamDecompress::scheduleSwathCopy(), and grk::TileCompletion::wait().

◆ tile_x0

uint16_t grk_wait_swath::tile_x0

Output: Global tile column start (inclusive).

Referenced by grk::CodeStreamDecompress::scheduleSwathCopy(), and grk::TileCompletion::wait().

◆ tile_x1

uint16_t grk_wait_swath::tile_x1

Output: Global tile column end (exclusive).

Referenced by grk::TileCompletion::wait().

◆ tile_y0

uint16_t grk_wait_swath::tile_y0

Output: Global tile row start (inclusive).

Referenced by grk::CodeStreamDecompress::scheduleSwathCopy(), and grk::TileCompletion::wait().

◆ tile_y1

uint16_t grk_wait_swath::tile_y1

Output: Global tile row end (exclusive).

Referenced by grk::TileCompletion::wait().

◆ x0

uint32_t grk_wait_swath::x0

Input: Pixel coordinate: top-left x.

Referenced by grk::TileCompletion::wait().

◆ x1

uint32_t grk_wait_swath::x1

Input: Pixel coordinate: bottom-right x (exclusive).

Referenced by grk::TileCompletion::wait().

◆ y0

uint32_t grk_wait_swath::y0

Input: Pixel coordinate: top-left y.

Referenced by grk::TileCompletion::wait().

◆ y1

uint32_t grk_wait_swath::y1

Input: Pixel coordinate: bottom-right y (exclusive).

Referenced by grk::TileCompletion::wait().


The documentation for this struct was generated from the following file: