olc::Sprite Class Reference

#include <olcPixelGameEngine.h>

Public Types
enum	Mode { NORMAL , PERIODIC , CLAMP }
enum	Flip { NONE = 0 , HORIZ = 1 , VERT = 2 }

Public Member Functions
	Sprite ()
	Sprite (const std::string &sImageFile, olc::ResourcePack *pack=nullptr)
	Sprite (int32_t w, int32_t h)
	Sprite (const olc::Sprite &)=delete
	~Sprite ()
olc::rcode	LoadFromFile (const std::string &sImageFile, olc::ResourcePack *pack=nullptr)
void	SetSampleMode (olc::Sprite::Mode mode=olc::Sprite::Mode::NORMAL)
Pixel	GetPixel (int32_t x, int32_t y) const
bool	SetPixel (int32_t x, int32_t y, Pixel p)
Pixel	GetPixel (const olc::vi2d &a) const
bool	SetPixel (const olc::vi2d &a, Pixel p)
Pixel	Sample (float x, float y) const
Pixel	Sample (const olc::vf2d &uv) const
Pixel	SampleBL (float u, float v) const
Pixel	SampleBL (const olc::vf2d &uv) const
Pixel *	GetData ()
olc::Sprite *	Duplicate ()
olc::Sprite *	Duplicate (const olc::vi2d &vPos, const olc::vi2d &vSize)
olc::vi2d	Size () const
void	SetSize (int32_t w, int32_t h)

Public Attributes
int32_t	width = 0
int32_t	height = 0
std::vector< olc::Pixel >	pColData
Mode	modeSample = Mode::NORMAL

Static Public Attributes
static std::unique_ptr< olc::ImageLoader >	loader

Member Enumeration Documentation

Flip

enum olc::Sprite::Flip

Enumerator
NONE
HORIZ
VERT

Mode

enum olc::Sprite::Mode

Enumerator
NORMAL
PERIODIC
CLAMP

Constructor & Destructor Documentation

Sprite() [1/4]

olc::Sprite::Sprite

(

)

Sprite() [2/4]

olc::Sprite::Sprite	(	const std::string &	sImageFile,
		olc::ResourcePack *	pack = nullptr )

Sprite() [3/4]

olc::Sprite::Sprite	(	int32_t	w,
		int32_t	h )

Sprite() [4/4]

olc::Sprite::Sprite ( const olc::Sprite & )

delete

~Sprite()

olc::Sprite::~Sprite

(

)

Member Function Documentation

Duplicate() [1/2]

olc::Sprite * olc::Sprite::Duplicate

(

)

Duplicate() [2/2]

olc::Sprite * olc::Sprite::Duplicate	(	const olc::vi2d &	vPos,
		const olc::vi2d &	vSize )

GetData()

Pixel * olc::Sprite::GetData

(

)

GetPixel() [1/2]

Pixel olc::Sprite::GetPixel

(

const olc::vi2d &

a

)

const

GetPixel() [2/2]

Pixel olc::Sprite::GetPixel	(	int32_t	x,
		int32_t	y ) const

LoadFromFile()

olc::rcode olc::Sprite::LoadFromFile	(	const std::string &	sImageFile,
		olc::ResourcePack *	pack = nullptr )

Sample() [1/2]

Pixel olc::Sprite::Sample

(

const olc::vf2d &

uv

)

const

Sample() [2/2]

Pixel olc::Sprite::Sample	(	float	x,
		float	y ) const

SampleBL() [1/2]

Pixel olc::Sprite::SampleBL

(

const olc::vf2d &

uv

)

const

SampleBL() [2/2]

Pixel olc::Sprite::SampleBL	(	float	u,
		float	v ) const

SetPixel() [1/2]

bool olc::Sprite::SetPixel	(	const olc::vi2d &	a,
		Pixel	p )

SetPixel() [2/2]

bool olc::Sprite::SetPixel	(	int32_t	x,
		int32_t	y,
		Pixel	p )

SetSampleMode()

void olc::Sprite::SetSampleMode

(

olc::Sprite::Mode

mode = olc::Sprite::Mode::NORMAL

)

SetSize()

void olc::Sprite::SetSize	(	int32_t	w,
		int32_t	h )

Size()

olc::vi2d olc::Sprite::Size

(

)

const

Member Data Documentation

height

int32_t olc::Sprite::height = 0

loader

std::unique_ptr<olc::ImageLoader> olc::Sprite::loader

static

modeSample

Mode olc::Sprite::modeSample = Mode::NORMAL

pColData

std::vector<olc::Pixel> olc::Sprite::pColData

width

int32_t olc::Sprite::width = 0

---

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

• olcPixelGameEngine.h