pfs::DOMIO Class Reference

Reading and writing frames in PFS format from/to streams. More...

#include <pfs.h>

List of all members.

Public Member Functions
Frame *	createFrame (int width, int height)
	Creates a frame that can be latter written to the stream using writeFrame method.
Frame *	readFrame (FILE *inputStream)
	Read PFS frame from the input Stream.
void	writeFrame (Frame *frame, FILE *outputStream)
	Writes Frame object to outputStream in PFS format.
void	freeFrame (Frame *frame)
	Deallocated memory allocated with createFrame or readFrame.

---

Detailed Description

Reading and writing frames in PFS format from/to streams.

Definition at line 383 of file pfs.h.

---

Member Function Documentation

Frame* pfs::DOMIO::createFrame	(	int	width,
		int	height
	)

Creates a frame that can be latter written to the stream using writeFrame method.

This method and readFrame are the only way to create Frame objects.

Note: Frame object must be released with freeFrame methods as soon as it is no longer needed. Otherwise the application will run out of memory.

Parameters:

	width	width of the frame to create
	height	height of the frame to create

Returns:

Frame object that can be modified and written back to PFS stream using writeFrame method

Frame* pfs::DOMIO::readFrame

(

FILE *

inputStream

)

Read PFS frame from the input Stream.

This method and createFrame are the only way to create Frame objects.

Note: Frame object must be released with freeFrame methods as soon as it is no longer needed. Otherwise the application will run out of memory.

Parameters:

inputStream

read frame from that stream

Returns:

Frame object that contains PFS frame read from the stream. NULL if there are no more frames.

void pfs::DOMIO::writeFrame	(	Frame *	frame,
		FILE *	outputStream
	)

Writes Frame object to outputStream in PFS format.

Parameters:

	frame	Frame object to be written. This object must be created with readFrame or createFrame method.
	outputStream	write frame to that stream

void pfs::DOMIO::freeFrame

(

Frame *

frame

)

Deallocated memory allocated with createFrame or readFrame.

Must be called as soon as frame is not needed. Pointer to a frame is invalid after this method call.

Parameters:

frame

Frame object to be freed

---

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

• pfs.h

---