FrameCollector Class Reference

Inheritance diagram for FrameCollector:

[legend]

Collaboration diagram for FrameCollector:

[legend]

List of all members.

---

Detailed Description

Provides an interface enabling third parties to retrieve the resulting frame of a render pass.

This interface can be used to implement snapshotting and video recording.

It works like this: when you supply a FrameCollector object when rendering it will call collect_frame(int, int, const uint8_t *) with the frame data once the scene has been rendered. The format in which the data is fed to collect_frame can be specified in the constructor or by calling set_pixel_format(PixelFormat).

Public Types
enum	PixelFormat { RGB, BGR }
Public Member Functions
	FrameCollector (PixelFormat format=RGB)
virtual void	collect_frame (int w, int h, const uint8_t *pixel_data)=0 throw ()
PixelFormat	get_pixel_format () const throw ()
Protected Member Functions
void	set_pixel_format (PixelFormat format) throw ()
Private Attributes
PixelFormat	m_pixel_format

---

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

• src/renderer/FrameCollector.hh