backend_pbm.h File Reference

This compilation unit provides functionality to render a bitmap struct to a PBM image (binary version, stored in a buffer). More...

#include "../saxbospiral.h"
#include "../render.h"

Include dependency graph for backend_pbm.h:

Go to the source code of this file.

Functions
sxbp_status_t	sxbp_render_backend_pbm (sxbp_bitmap_t bitmap, sxbp_buffer_t *buffer)
	Renders a bitmap image to a PBM image. More...

Detailed Description

This compilation unit provides functionality to render a bitmap struct to a PBM image (binary version, stored in a buffer).

Remarks

Reference materials used for the PBM format are located at http://netpbm.sourceforge.net/doc/pbm.html

Author

Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==.com

Date

2016, 2017

Copyright

Copyright (C) Joshua Saxby 2016, 2017

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Function Documentation

sxbp_status_t sxbp_render_backend_pbm	(	sxbp_bitmap_t	bitmap,
		sxbp_buffer_t *	buffer
	)

Renders a bitmap image to a PBM image.

Parameters

	bitmap	Bitmap containing the image to render.
[out]	buffer	Buffer to write out the PBM image data to.

Returns

SXBP_OPERATION_OK on success.

SXBP_MALLOC_REFUSED on memory allocation failure.

Note

Asserts:

• That bitmap.pixels is not NULL
• That buffer->bytes is NULL