ScreenshotProvider_Bmp Class Reference

Inheritance diagram for ScreenshotProvider_Bmp:

Public Member Functions
bool	MakeImage (std::string_view name, const ScreenshotCallback &callb, uint w, uint h, int pixelformat, const Colour *palette) const override
	Create and write an image to a file.
Public Member Functions inherited from ScreenshotProvider
	ScreenshotProvider (std::string_view name, std::string_view description, int priority)
	~ScreenshotProvider () override
	Unregister ourselves from the screenshot providers.
Public Member Functions inherited from PriorityBaseProvider< ScreenshotProvider >
constexpr	PriorityBaseProvider (std::string_view name, std::string_view description, int priority)
	Create the provider.
int	GetPriority () const
	Get the priority of this provider.
Public Member Functions inherited from BaseProvider< ScreenshotProvider >
constexpr	BaseProvider (std::string_view name, std::string_view description)
	Create the provider.
virtual	~BaseProvider ()=default
	Ensure the destructor of the sub classes are called as well.
std::string_view	GetName () const
	Get the name of this provider.
std::string_view	GetDescription () const
	Get a description of this provider.

Static Private Attributes
static ScreenshotProvider_Bmp	instance {}

Additional Inherited Members
Protected Attributes inherited from PriorityBaseProvider< ScreenshotProvider >
const int	priority
	The priority of this provider.
Protected Attributes inherited from BaseProvider< ScreenshotProvider >
const std::string_view	name
	The name of the provider.
const std::string_view	description
	A description of the provider.

Detailed Description

Definition at line 42 of file screenshot_bmp.cpp.

Constructor & Destructor Documentation

ScreenshotProvider_Bmp()

ScreenshotProvider_Bmp::ScreenshotProvider_Bmp ( )

inline

Definition at line 44 of file screenshot_bmp.cpp.

Member Function Documentation

MakeImage()

bool ScreenshotProvider_Bmp::MakeImage ( std::string_view name, const ScreenshotCallback & callb, uint w, uint h, int pixelformat, const Colour * palette ) const

inlineoverridevirtual

Create and write an image to a file.

Parameters

name	The file name to write to.
callb	The callback that fills a buffer with pixel data.
w	The width of the image.
h	The height of the image.
pixelformat	The number of bits per pixel for the image.
palette	The palette that is currently being used.

Returns

Whether writing the image was successful of not.

Implements ScreenshotProvider.

Definition at line 46 of file screenshot_bmp.cpp.

References Align(), Clamp(), BaseProvider< ScreenshotProvider >::name, and FileHandle::Open().

Field Documentation

instance

ScreenshotProvider_Bmp ScreenshotProvider_Bmp::instance {}

staticprivate

Definition at line 153 of file screenshot_bmp.cpp.

---

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

• src/screenshot_bmp.cpp