From c62dc88bc2c1fbf528f700b92b1c83585f592d1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Madar=C3=A1sz?= Date: Tue, 28 Nov 2023 14:50:32 +0100 Subject: [PATCH] docs --- engine/joint/v4k.h | 37 ++++++++++++++++++------------------- engine/split/v4k_gui.h | 37 ++++++++++++++++++------------------- engine/v4k.h | 37 ++++++++++++++++++------------------- 3 files changed, 54 insertions(+), 57 deletions(-) diff --git a/engine/joint/v4k.h b/engine/joint/v4k.h index e112a1f..a8dea33 100644 --- a/engine/joint/v4k.h +++ b/engine/joint/v4k.h @@ -18145,30 +18145,29 @@ API void gui_popskin(); // default renderers -/// skinned typedef struct skinned_t { atlas_t atlas; float scale; } skinned_t; -// The skinning engine depends on an Aseprite asset with slices set up. -// While you can specify your own skins for various GUI widgets, some -// skin variants are hardcoded and expected to be present in your asset: -// -// gui_panel(): -// - "panel" (overridable) -// gui_button(): -// - "button" (base overridable) -// - "_hover" (ex. "scarybtn_hover") -// - "_press" -// gui_rect(): -// - no defaults, always pass your own skin/slice name -// gui_slider(): -// - "slider" (overridable) -// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") -// - "_hover" (ex. "slider_cursor_hover") -// - "_press" -// +/// The skinning engine depends on an Aseprite asset with slices set up. +/// While you can specify your own skins for various GUI widgets, some +/// skin variants are hardcoded and expected to be present in your asset: +/// +/// gui_panel(): +/// - "panel" (overridable) +/// gui_button(): +/// - "button" (base overridable) +/// - "_hover" (ex. "scarybtn_hover") +/// - "_press" +/// gui_rect(): +/// - no defaults, always pass your own skin/slice name +/// gui_slider(): +/// - "slider" (overridable) +/// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") +/// - "_hover" (ex. "slider_cursor_hover") +/// - "_press" +/// API guiskin_t gui_skinned(const char *asefile, float scale); #line 0 diff --git a/engine/split/v4k_gui.h b/engine/split/v4k_gui.h index 9d8cecd..3e20442 100644 --- a/engine/split/v4k_gui.h +++ b/engine/split/v4k_gui.h @@ -30,28 +30,27 @@ API void gui_popskin(); // default renderers -/// skinned typedef struct skinned_t { atlas_t atlas; float scale; } skinned_t; -// The skinning engine depends on an Aseprite asset with slices set up. -// While you can specify your own skins for various GUI widgets, some -// skin variants are hardcoded and expected to be present in your asset: -// -// gui_panel(): -// - "panel" (overridable) -// gui_button(): -// - "button" (base overridable) -// - "_hover" (ex. "scarybtn_hover") -// - "_press" -// gui_rect(): -// - no defaults, always pass your own skin/slice name -// gui_slider(): -// - "slider" (overridable) -// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") -// - "_hover" (ex. "slider_cursor_hover") -// - "_press" -// +/// The skinning engine depends on an Aseprite asset with slices set up. +/// While you can specify your own skins for various GUI widgets, some +/// skin variants are hardcoded and expected to be present in your asset: +/// +/// gui_panel(): +/// - "panel" (overridable) +/// gui_button(): +/// - "button" (base overridable) +/// - "_hover" (ex. "scarybtn_hover") +/// - "_press" +/// gui_rect(): +/// - no defaults, always pass your own skin/slice name +/// gui_slider(): +/// - "slider" (overridable) +/// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") +/// - "_hover" (ex. "slider_cursor_hover") +/// - "_press" +/// API guiskin_t gui_skinned(const char *asefile, float scale); diff --git a/engine/v4k.h b/engine/v4k.h index 39863b4..8a9a755 100644 --- a/engine/v4k.h +++ b/engine/v4k.h @@ -4212,30 +4212,29 @@ API void gui_popskin(); // default renderers -/// skinned typedef struct skinned_t { atlas_t atlas; float scale; } skinned_t; -// The skinning engine depends on an Aseprite asset with slices set up. -// While you can specify your own skins for various GUI widgets, some -// skin variants are hardcoded and expected to be present in your asset: -// -// gui_panel(): -// - "panel" (overridable) -// gui_button(): -// - "button" (base overridable) -// - "_hover" (ex. "scarybtn_hover") -// - "_press" -// gui_rect(): -// - no defaults, always pass your own skin/slice name -// gui_slider(): -// - "slider" (overridable) -// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") -// - "_hover" (ex. "slider_cursor_hover") -// - "_press" -// +/// The skinning engine depends on an Aseprite asset with slices set up. +/// While you can specify your own skins for various GUI widgets, some +/// skin variants are hardcoded and expected to be present in your asset: +/// +/// gui_panel(): +/// - "panel" (overridable) +/// gui_button(): +/// - "button" (base overridable) +/// - "_hover" (ex. "scarybtn_hover") +/// - "_press" +/// gui_rect(): +/// - no defaults, always pass your own skin/slice name +/// gui_slider(): +/// - "slider" (overridable) +/// - "slider_cursor" (partially overridable, ex. "bigslider_cursor") +/// - "_hover" (ex. "slider_cursor_hover") +/// - "_press" +/// API guiskin_t gui_skinned(const char *asefile, float scale); #line 0