qoi_viewer.h File Reference

This header contains declaration of functions related to QOI viewer. More...

#include "sQOI.h"
#include <stdint.h>
#include <stdbool.h>
#include <libdragon.h>

Go to the source code of this file.

Data Structures
struct	qoi_img_info
	Metadata about the QOI image and the QOI image viewer. More...

Macros
#define	IMG_BUFFER_SIZE   307200
	Image buffer size: 320 pixels in width * 240 pixels in height * 4 channels.

Typedefs
typedef enum qoi_error_code	qoi_error_code
	Error codes for different situations when handling a QOI file.
typedef struct qoi_img_info	qoi_img_info_t
	Metadata about the QOI image and the QOI image viewer.

Enumerations
enum	qoi_error_code {   QOI_NOT_INITIALIZED = -1 , QOI_OK , QOI_NULL_BUFFER , QOI_INVAILD_FILE ,   QOI_NO_FILE , QOI_NO_FILENAME }
	Error codes for different situations when handling a QOI file. More...

Functions
void	draw_image (surface_t *disp, qoi_img_info_t info)
	This function draws image decoded from QOI.
void	openQOIFile (const char *filename, uint8_t *bytes, qoi_img_info_t *info)
	This function decodes QOI file from from into the framebuffer.
void	toggleDebugText (qoi_img_info_t *info)
	Toggles printing debugging text.

Variables
uint8_t	buffer0 [IMG_BUFFER_SIZE]
	Raw image buffer that decoded from qoi image file.
uint8_t	buffer1 [IMG_BUFFER_SIZE]
	second raw image buffer that decoded from qoi image file

Detailed Description

This header contains declaration of functions related to QOI viewer.

Enumeration Type Documentation

qoi_error_code

enum qoi_error_code

Error codes for different situations when handling a QOI file.

Enumerator
QOI_NOT_INITIALIZED	QOI Image not yet decoded.
QOI_OK	QOI Image decoded successfully.
QOI_NULL_BUFFER	No buffer for image found.
QOI_INVAILD_FILE	Invaild QOI image file found.
QOI_NO_FILE	No file found given a filename to the supposed QOI image.
QOI_NO_FILENAME	Filename to the QOI image not passed to decoder.

Function Documentation

draw_image()

void draw_image	(	surface_t *	disp,
		qoi_img_info_t	info )

This function draws image decoded from QOI.

Parameters

disp	Surface image
info	QOI info for drawing image properly

openQOIFile()

void openQOIFile	(	const char *	filename,
		uint8_t *	bytes,
		qoi_img_info_t *	info )

This function decodes QOI file from from into the framebuffer.

Parameters

filename	Name of the QOI file
bytes	Pointer to a raw image buffer
info	QOI decoding info as a result of decoding qoi file

toggleDebugText()

void toggleDebugText ( qoi_img_info_t * info )

inline

Toggles printing debugging text.

Parameters

info	QOI decoding info