Harlequin RIP SDK
rasterstoreapi.h File Reference

Header file defining the Raster store interface. More...

Data Structures

struct  raster_store_params
 Parameters to control the raster store. More...
 
struct  raster_store_sizes
 Structure used by raster_store_flush() to return the sizes of different types of memory used. More...
 
struct  sw_rasterstore_api_20220429
 Raster store API version 20220429. More...
 

Macros

#define RASTER_STORE_PARAMS_INIT
 Default initialiser for raster store params.
 

Typedefs

typedef struct raster_store_t raster_store_t
 Opaque type of raster store.
 
typedef struct raster_store_read_t raster_store_read_t
 Opaque type of raster store reader context.
 
typedef struct raster_store_params raster_store_params
 Parameters to control the raster store.
 
typedef struct raster_store_sizes raster_store_sizes
 Structure used by raster_store_flush() to return the sizes of different types of memory used.
 
typedef struct sw_rasterstore_api_20220429 sw_rasterstore_api_20220429
 Raster store API version 20220429.
 

Enumerations

enum  { RASTER_USE_UNCOMPRESSED_MEMORY = 1 , RASTER_USE_COMPRESSED_MEMORY = 2 , RASTER_USE_DISK = 4 , RASTER_USE_ALL = RASTER_USE_UNCOMPRESSED_MEMORY | RASTER_USE_COMPRESSED_MEMORY | RASTER_USE_DISK }
 Flags for determining how to store the raster data. More...
 
enum  { RASTER_COMPRESS_LZ4 , RASTER_COMPRESS_FLATE }
 Type of compression for the raster store. More...
 

Functions

HqnResult raster_store_create (const raster_store_params *params, raster_store_t **pstore)
 Create a raster store object. More...
 
void raster_store_destroy (raster_store_t **pstore)
 Destroy a raster store object. More...
 
HqnResult raster_store_write (raster_store_t *store, unsigned int startline, unsigned int nlines, const struct RASTER_PLANE *plane, const uint8 *buffer)
 Write a range of lines to a raster store. More...
 
raster_store_read_traster_store_read_open (raster_store_t *store, const struct RASTER_PLANE *plane, HqnResult *perr)
 Open a context to read data from a raster store. More...
 
const uint8raster_store_map_lines (raster_store_read_t *ctxt, unsigned int *pstartline, unsigned int *pnlines, const struct RASTER_PLANE **playout, HqnResult *perr)
 Map the data for a range of lines in a raster store into memory. More...
 
HqnResult raster_store_load_lines (raster_store_read_t *ctxt, unsigned int *pstartline, unsigned int *pnlines, uint8 *buffer, const struct RASTER_PLANE **playout)
 Load data for a range of lines from a raster store into a client's memory buffer. More...
 
void raster_store_read_close (raster_store_read_t **pctxt)
 Close a context previously opened to read data from a raster store. More...
 
void raster_store_flush (raster_store_t *store, int storage_flags, size_t *recover, raster_store_sizes *psizes)
 Compress, decompress, load and/or save data in a raster store to match requested storage tiers, and return a measure of the sizes of the data in different storage tiers. More...
 

Detailed Description

Header file defining the Raster store interface.

Copyright (C) 2023 Global Graphics Software Ltd. All rights reserved. Global Graphics Software Ltd. Confidential Information.