JadeEngine::ButtonParams Struct Reference

#include <Button.h>

Public Attributes
ObjectLayer	layer
std::string	textureNormal
std::string	texturePressed
std::string	textureDisabled
std::string	textureHovered
bool	spriteSheet
std::string	spriteSheetName
int32_t	width
int32_t	height
int32_t	z
int32_t	cornerSize
int32_t	pressedDepth
std::string	text
std::string	fontName
uint32_t	fontSize
SDL_Color	textColor
SDL_Color	disabledTextColor
std::string	clickSound

Detailed Description

Parameters required to create a Button game object.

See also

Game::Create

Template to copy:

ButtonParams buttonParams;
buttonParams.layer = kObjectLayer_UI;
buttonParams.textureNormal = "blue_button09.png";
buttonParams.texturePressed = "blue_button10.png";
buttonParams.textureDisabled = "grey_button11.png";
buttonParams.textureHovered = "blue_button14.png";
buttonParams.spriteSheet = true;
buttonParams.spriteSheetName = "engineUI";
buttonParams.width = 250;
buttonParams.height = 50;
buttonParams.z = 0;
buttonParams.cornerSize = 9;
buttonParams.pressedDepth = 5;
buttonParams.text = "Button";
buttonParams.fontName = "vera";
buttonParams.fontSize = 32;
buttonParams.textColor = { 255, 255, 255, 255 };
buttonParams.disabledTextColor = { 153, 153, 153, 255 };
buttonParams.clickSound = "uiClick";

Member Data Documentation

layer

ObjectLayer JadeEngine::ButtonParams::layer

Layer that will the Sprite belong to.

See also

ObjectLayer

spriteSheet

bool JadeEngine::ButtonParams::spriteSheet

Whether the textureNormal, texturePressed, textureDisabled, textureHovered refer to sprite-sheet contained textures. Same meaning as SpriteParams::spriteSheet.

See also

SpriteParams::spriteSheet, ButtonParams::spriteSheetName

spriteSheetName

std::string JadeEngine::ButtonParams::spriteSheetName

If spriteSheet is true defines the texture to use as sprite-sheet source. Same meaning as SpriteParams::spriteSheetName.

See also

SpriteParams::spriteSheetName, ButtonParams::spriteSheet

textureDisabled

std::string JadeEngine::ButtonParams::textureDisabled

Texture to use representing the button when it is disabled.

If the spriteSheet is true this refers to a texture defined in a sprite-sheet. See SpriteParams::textureName for more details.

See also

SpriteParams::textureName, Button::Disable

textureHovered

std::string JadeEngine::ButtonParams::textureHovered

Texture to use on top of textureNormal when the button is hovered by mouse.

If the spriteSheet is true this refers to a texture defined in a sprite-sheet. See SpriteParams::textureName for more details.

See also

SpriteParams::textureName, Button::Disable

textureNormal

std::string JadeEngine::ButtonParams::textureNormal

Texture to use representing the button when it is in the normal state.

If the spriteSheet is true this refers to a texture defined in a sprite-sheet. See SpriteParams::textureName for more details.

See also

SpriteParams::textureName

texturePressed

std::string JadeEngine::ButtonParams::texturePressed

Texture to use representing the button when it is in the pressed state.

If the spriteSheet is true this refers to a texture defined in a sprite-sheet. See SpriteParams::textureName for more details.

See also

SpriteParams::textureName

---

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

• include/Button.h