OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::InputIcon Namespace Reference

入力操作を可視化するアイコン More...

Functions

Vec2 GetSize (StringView label, const Font &font, double size)
 アイコンのサイズ(ピクセル)を返します。 More...
 
Vec2 GetSize (const Input &input, const Font &font, double size)
 アイコンのサイズ(ピクセル)を返します。 More...
 
void DrawAt (StringView label, bool isPressed, const Vec2 &center, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black)
 入力操作を可視化するアイコンを描画します。 More...
 
void DrawInteractiveAt (const Input &input, const Vec2 &center, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black, const ColorF &highlightColor=DefaultHighlightColor)
 入力操作を可視化するインタラクティブなアイコンを描画します。 More...
 
void DrawAt (const Input &input, bool isPressed, const Vec2 &center, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black, const ColorF &highlightColor=DefaultHighlightColor)
 入力操作を可視化するアイコンを描画します。 More...
 
void Draw (StringView label, bool isPressed, const Vec2 &pos, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black)
 入力操作を可視化するアイコンを描画します。 More...
 
void DrawInteractive (const Input &input, const Vec2 &pos, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black, const ColorF &highlightColor=DefaultHighlightColor)
 入力操作を可視化するインタラクティブなアイコンを描画します。 More...
 
void Draw (const Input &input, bool isPressed, const Vec2 &pos, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black, const ColorF &highlightColor=DefaultHighlightColor)
 入力操作を可視化するアイコンを描画します。 More...
 
double DrawAsGlyph (const Input &input, const Vec2 &pos, const Font &font, double size, const ColorF &keyColor=Palette::White, const ColorF &labelColor=Palette::Black, const ColorF &highlightColor=DefaultHighlightColor)
 入力操作を可視化するアイコンを描画します。 More...
 

Variables

constexpr ColorF DefaultHighlightColor { 1.0, 0.6, 0.6 }
 デフォルトのハイライトカラー More...
 

Detailed Description

入力操作を可視化するアイコン

Function Documentation

◆ Draw() [1/2]

void s3d::InputIcon::Draw ( const Input input,
bool  isPressed,
const Vec2 pos,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black,
const ColorF highlightColor = DefaultHighlightColor 
)
inline

入力操作を可視化するアイコンを描画します。

Parameters
input入力オブジェクト
isPressed押されている状態か
posアイコンを描画する左上の座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色
highlightColor押されている操作のときのアイコンのハイライト色

◆ Draw() [2/2]

void s3d::InputIcon::Draw ( StringView  label,
bool  isPressed,
const Vec2 pos,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black 
)
inline

入力操作を可視化するアイコンを描画します。

Parameters
labelアイコンのラベル
isPressed押されている状態か
posアイコンを描画する左上の座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色

◆ DrawAsGlyph()

double s3d::InputIcon::DrawAsGlyph ( const Input input,
const Vec2 pos,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black,
const ColorF highlightColor = DefaultHighlightColor 
)
inline

入力操作を可視化するアイコンを描画します。

Remarks
Glyph と混在して描画しやすいよう描画座標が調整されます。
Parameters
input入力オブジェクト
posアイコンを描画する左上の座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色
highlightColor押されている操作のときのアイコンのハイライト色
Returns
アイコンの幅(ピクセル)

◆ DrawAt() [1/2]

void s3d::InputIcon::DrawAt ( const Input input,
bool  isPressed,
const Vec2 center,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black,
const ColorF highlightColor = DefaultHighlightColor 
)
inline

入力操作を可視化するアイコンを描画します。

Parameters
input入力オブジェクト
isPressed押されている状態か
centerアイコンを描画する中心座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色
highlightColor押されている操作のときのアイコンのハイライト色

◆ DrawAt() [2/2]

void s3d::InputIcon::DrawAt ( StringView  label,
bool  isPressed,
const Vec2 center,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black 
)
inline

入力操作を可視化するアイコンを描画します。

Parameters
labelアイコンのラベル
isPressed押されている状態か
centerアイコンを描画する中心座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色

◆ DrawInteractive()

void s3d::InputIcon::DrawInteractive ( const Input input,
const Vec2 pos,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black,
const ColorF highlightColor = DefaultHighlightColor 
)
inline

入力操作を可視化するインタラクティブなアイコンを描画します。

Parameters
input入力オブジェクト
posアイコンを描画する左上の座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色
highlightColor押されている操作のときのアイコンのハイライト色

◆ DrawInteractiveAt()

void s3d::InputIcon::DrawInteractiveAt ( const Input input,
const Vec2 center,
const Font font,
double  size,
const ColorF keyColor = Palette::White,
const ColorF labelColor = Palette::Black,
const ColorF highlightColor = DefaultHighlightColor 
)
inline

入力操作を可視化するインタラクティブなアイコンを描画します。

Parameters
input入力オブジェクト
centerアイコンを描画する中心座標
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
keyColorアイコンの色
labelColorラベルの色
highlightColor押されている操作のときのアイコンのハイライト色

◆ GetSize() [1/2]

Vec2 s3d::InputIcon::GetSize ( const Input input,
const Font font,
double  size 
)
inline

アイコンのサイズ(ピクセル)を返します。

Parameters
input入力オブジェクト
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
Returns
アイコンのサイズ(ピクセル)

◆ GetSize() [2/2]

Vec2 s3d::InputIcon::GetSize ( StringView  label,
const Font font,
double  size 
)
inline

アイコンのサイズ(ピクセル)を返します。

Parameters
labelアイコンのラベル
fontラベルに使用するフォント
sizeアイコンの縦のサイズ(ピクセル)
Returns
アイコンのサイズ(ピクセル)

Variable Documentation

◆ DefaultHighlightColor

constexpr ColorF s3d::InputIcon::DefaultHighlightColor { 1.0, 0.6, 0.6 }
inlineconstexpr

デフォルトのハイライトカラー