jade-engine  0.0
JadeEngine::GameInitParamsSpriteSheetEntry Struct Reference

#include <GameInitParams.h>

Public Attributes

std::string assetName
 
std::string textureFileLocation
 
std::string sheetJSONFileLocation
 
TextureSampling sampling
 

Detailed Description

Parameters for loading a sprite-sheet.

Member Data Documentation

◆ assetName

std::string JadeEngine::GameInitParamsSpriteSheetEntry::assetName

String to identify the sprite-sheet that will be used to reference it when creating game objects with textures that support sprite-sheets.

Must be unique across all loaded sprite-sheets.

◆ sampling

TextureSampling JadeEngine::GameInitParamsSpriteSheetEntry::sampling

How will the texture be sampled when rendering it in a different scale then 100%.

This will be applied to all sprites created from this sprite-sheet.

It is possible to overwrite this per Sprite at the cost of texture copy.

See also
TextureSampling, Sprite::SetSampling

◆ sheetJSONFileLocation

std::string JadeEngine::GameInitParamsSpriteSheetEntry::sheetJSONFileLocation

String with full path to the sprite-sheet configuration file relative to the executable.

For example "assets/engineUI.json".

◆ textureFileLocation

std::string JadeEngine::GameInitParamsSpriteSheetEntry::textureFileLocation

String with full path to the sprite-sheet texture file relative to the executable.

For example "assets/engineUI.png".


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