mage::rendering::SpriteFontOutput Struct Reference

#include <sprite_font_output.hpp>

Public Member Functions
	SpriteFontOutput ()=default
	SpriteFontOutput (const SpriteFontOutput &output)=delete
	SpriteFontOutput (SpriteFontOutput &&output) noexcept=default
	~SpriteFontOutput ()=default
SpriteFontOutput &	operator= (const SpriteFontOutput &output)=delete
SpriteFontOutput &	operator= (SpriteFontOutput &&output) noexcept=default

Public Attributes
ComPtr< ID3D11ShaderResourceView >	m_texture_srv
std::vector< Glyph >	m_glyphs
wchar_t	m_default_character
F32	m_line_spacing

Detailed Description

A struct of sprite font outputs for storing the data of a sprite font.

Constructor & Destructor Documentation

SpriteFontOutput() [1/3]

mage::rendering::SpriteFontOutput::SpriteFontOutput ( )

default

Constructs a sprite font output.

SpriteFontOutput() [2/3]

mage::rendering::SpriteFontOutput::SpriteFontOutput ( const SpriteFontOutput &  output )

delete

Constructs a sprite font output from the given sprite font output.

Parameters

[in]

output

A reference to the sprite font output to copy.

SpriteFontOutput() [3/3]

mage::rendering::SpriteFontOutput::SpriteFontOutput ( SpriteFontOutput &&  output )

defaultnoexcept

Constructs a sprite font output by moving the given sprite font output.

Parameters

[in]

output

A reference to the sprite font output to move.

~SpriteFontOutput()

mage::rendering::SpriteFontOutput::~SpriteFontOutput ( )

default

Destructs this sprite font output.

Member Function Documentation

operator=() [1/2]

SpriteFontOutput& mage::rendering::SpriteFontOutput::operator= ( const SpriteFontOutput &  output )

delete

Copies the given sprite font output to this sprite font output.

Parameters

[in]

output

A reference to the sprite font output to copy.

Returns

A reference to the copy of the given sprite font output (i.e. this sprite font output).

operator=() [2/2]

SpriteFontOutput& mage::rendering::SpriteFontOutput::operator= ( SpriteFontOutput &&  output )

defaultnoexcept

Moves the given sprite font output to this sprite font output.

Parameters

[in]

output

A reference to the sprite font output to move.

Returns

A reference to the moved sprite font output (i.e. this sprite font output).

Member Data Documentation

m_default_character

wchar_t mage::rendering::SpriteFontOutput::m_default_character

The default character of the sprite font of this sprite font output.

m_glyphs

std::vector< Glyph > mage::rendering::SpriteFontOutput::m_glyphs

A vector containing the glyphs of the sprite font of this sprite font output.

m_line_spacing

F32 mage::rendering::SpriteFontOutput::m_line_spacing

The (extra) line spacing of the sprite font of this sprite font output.

m_texture_srv

ComPtr< ID3D11ShaderResourceView > mage::rendering::SpriteFontOutput::m_texture_srv

A pointer to the texture of the sprite font of this sprite font output.