The base factory, keeping track of all blitters. More...

#include <factory.hpp>

Inheritance diagram for BlitterFactory:

Public Member Functions
std::string_view	GetName () const
	Get the long, human readable, name for the Blitter-class.

std::string_view	GetDescription () const
	Get a nice description of the blitter-class.

virtual std::unique_ptr< Blitter >	CreateInstance ()=0
	Create an instance of this Blitter-class.

Static Public Member Functions
static Blitter *	SelectBlitter (std::string_view name)
	Find the requested blitter and return its class.

static BlitterFactory *	GetBlitterFactory (std::string_view name)
	Get the blitter factory with the given name.

static Blitter *	GetCurrentBlitter ()
	Get the current active blitter (always set by calling SelectBlitter).

static void	GetBlittersInfo (std::back_insert_iterator< std::string > &output_iterator)
	Fill a buffer with information about the blitters.

Protected Member Functions
	BlitterFactory (std::string_view name, std::string_view description, bool usable=true)
	Construct the blitter, and register it.

virtual bool	IsUsable () const
	Is the blitter usable with the current drivers and hardware config?

Private Types
typedef std::map< std::string, BlitterFactory * >	Blitters
	Map of blitter factories.

Static Private Member Functions
static Blitters &	GetBlitters ()
	Get the map with currently known blitters.

static std::unique_ptr< Blitter > &	GetActiveBlitter ()
	Get the currently active blitter.

Private Attributes
const std::string	name
	The name of the blitter factory.

const std::string	description
	The description of the blitter.

Detailed Description

The base factory, keeping track of all blitters.

Definition at line 21 of file factory.hpp.

Member Typedef Documentation

◆ Blitters

typedef std::map<std::string, BlitterFactory *> BlitterFactory::Blitters

private

Map of blitter factories.

Definition at line 26 of file factory.hpp.

Constructor & Destructor Documentation

◆ BlitterFactory()

BlitterFactory::BlitterFactory	(	std::string_view	name,
		std::string_view	description,
		bool	usable = `true`
	)

inlineprotected

Construct the blitter, and register it.

Parameters

name	The name of the blitter.
description	A longer description for the blitter.
usable	Whether the blitter is usable (on the current computer). For example for disabling SSE blitters when the CPU can't handle them.

Precondition: name != nullptr.; description != nullptr.; There is no blitter registered with this name.

Definition at line 58 of file factory.hpp.

References Debug, GetBlitters(), and name.

◆ ~BlitterFactory()

virtual BlitterFactory::~BlitterFactory ( )

inlinevirtual

Definition at line 85 of file factory.hpp.

Member Function Documentation

◆ CreateInstance()

virtual std::unique_ptr< Blitter > BlitterFactory::CreateInstance ( )

pure virtual

Create an instance of this Blitter-class.

Implemented in FBlitter_32bppAnim, FBlitter_32bppOptimized, FBlitter_32bppSimple, FBlitter_40bppAnim, FBlitter_8bppOptimized, FBlitter_8bppSimple, and FBlitter_Null.

Referenced by SelectBlitter().

◆ GetActiveBlitter()

static std::unique_ptr< Blitter > & BlitterFactory::GetActiveBlitter ( )

inlinestaticprivate

Get the currently active blitter.

Returns: The currently active blitter.

Definition at line 42 of file factory.hpp.

Referenced by GetCurrentBlitter(), and SelectBlitter().

◆ GetBlitterFactory()

static BlitterFactory * BlitterFactory::GetBlitterFactory ( std::string_view name )

inlinestatic

Get the blitter factory with the given name.

Parameters

name	the blitter factory to select.

Returns: The blitter factory, or nullptr when there isn't one with the wanted name.

Definition at line 112 of file factory.hpp.

References GetBlitters(), IsUsable(), name, and StrEqualsIgnoreCase().

Referenced by SelectBlitter(), and SwitchNewGRFBlitter().

◆ GetBlitters()

static Blitters & BlitterFactory::GetBlitters ( )

inlinestaticprivate

Get the map with currently known blitters.

Returns: The known blitters.

Definition at line 32 of file factory.hpp.

Referenced by BlitterFactory(), GetBlitterFactory(), and GetBlittersInfo().

◆ GetBlittersInfo()

static void BlitterFactory::GetBlittersInfo ( std::back_insert_iterator< std::string > & output_iterator )

inlinestatic

Fill a buffer with information about the blitters.

Parameters

p	The buffer to fill.
last	The last element of the buffer.

Returns: p The location till where we filled the buffer.

Definition at line 147 of file factory.hpp.

References GetBlitters(), GetDescription(), and name.

Referenced by ShowHelp().

◆ GetCurrentBlitter()

static Blitter * BlitterFactory::GetCurrentBlitter ( )

inlinestatic

Get the current active blitter (always set by calling SelectBlitter).

Definition at line 136 of file factory.hpp.

References GetActiveBlitter().

Referenced by VideoDriver_SDL_Base::AfterBlitterChange(), VideoDriver_Win32GDI::AfterBlitterChange(), VideoDriver_SDL_Default::AllocateBackingStore(), VideoDriver_Win32GDI::AllocateBackingStore(), VideoDriver_SDL_Base::ClientSizeChanged(), CurrentScreenCallback(), DrawOverlappedWindow(), SmallMapWindow::DrawSmallMap(), DrawSpriteToRgbaBuffer(), FillDrawPixelInfo(), VideoDriver_Win32Base::GetFullscreenBpp(), OpenGLBackend::GetVideoBuffer(), VideoDriver_SDL_OpenGL::GetVideoPointer(), GfxBlitter(), GfxDoDrawLine(), GfxFillPolygon(), GfxFillRect(), HandleBootstrap(), HandleMouseEvents(), MakeLargeWorldScreenshot(), MakeSmallScreenshot(), VideoDriver_Win32Base::MakeWindow(), NetworkDrawChatMessage(), NetworkUndrawChatMessage(), OpenGLBackend::Paint(), VideoDriver_SDL_Default::Paint(), VideoDriver_SDL_OpenGL::Paint(), VideoDriver_Win32GDI::Paint(), ReadSprite(), OpenGLBackend::ReleaseVideoBuffer(), OpenGLBackend::Resize(), SelectBlitter(), VideoDriver_Dedicated::Start(), VideoDriver_SDL_Base::Start(), VideoDriver_Win32GDI::Start(), SurveyConfiguration(), SwitchNewGRFBlitter(), and ViewportDrawDirtyBlocks().

◆ GetDescription()

std::string_view BlitterFactory::GetDescription ( ) const

inline

Get a nice description of the blitter-class.

Definition at line 168 of file factory.hpp.

References description.

Referenced by GetBlittersInfo().

◆ GetName()

std::string_view BlitterFactory::GetName ( ) const

inline

Get the long, human readable, name for the Blitter-class.

Definition at line 160 of file factory.hpp.

References name.

◆ IsUsable()

virtual bool BlitterFactory::IsUsable ( ) const

inlineprotectedvirtual

Is the blitter usable with the current drivers and hardware config?

Returns: True if the blitter can be instantiated.

Reimplemented in FBlitter_40bppAnim.

Definition at line 79 of file factory.hpp.

Referenced by GetBlitterFactory().

◆ SelectBlitter()

static Blitter * BlitterFactory::SelectBlitter ( std::string_view name )

inlinestatic

Find the requested blitter and return its class.

Parameters

name	the blitter to select.

Postcondition: Sets the blitter so GetCurrentBlitter() returns it too.

Definition at line 96 of file factory.hpp.

References CreateInstance(), Debug, GetActiveBlitter(), GetBlitterFactory(), GetCurrentBlitter(), Blitter::GetName(), and name.

Referenced by openttd_main(), and VideoDriver_Null::Start().

Field Documentation

◆ description

const std::string BlitterFactory::description

private

The description of the blitter.

Definition at line 24 of file factory.hpp.

Referenced by GetDescription().

◆ name

const std::string BlitterFactory::name

private

The name of the blitter factory.

Definition at line 23 of file factory.hpp.

Referenced by BlitterFactory(), GetBlitterFactory(), GetBlittersInfo(), GetName(), and SelectBlitter().

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

src/blitter/factory.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Blitters

Constructor & Destructor Documentation

◆ BlitterFactory()

◆ ~BlitterFactory()

Member Function Documentation

◆ CreateInstance()

◆ GetActiveBlitter()

◆ GetBlitterFactory()

◆ GetBlitters()

◆ GetBlittersInfo()

◆ GetCurrentBlitter()

◆ GetDescription()

◆ GetName()

◆ IsUsable()

◆ SelectBlitter()

Field Documentation

◆ description

◆ name