Skip to content

Commit

Permalink
Add new section to gst lib.
Browse files Browse the repository at this point in the history
Also fix gtk-doc style as per warnings.
  • Loading branch information
Stefan Sauer committed Feb 11, 2024
1 parent 9dd6786 commit 56722c6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
11 changes: 11 additions & 0 deletions docs/reference/bt-gst/buzztrax-gst-sections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -471,6 +471,17 @@ gstbt_tone_conversion_get_type
gstbt_tone_conversion_tuning_get_type
</SECTION>

<SECTION>
<FILE>ui</FILE>
<TITLE>GstBtUi</TITLE>
GstBtUiCustomGfx
GstBtUiCustomGfxResponse
gstbt_ui_custom_gfx_request
<SUBSECTION Standard>
GSTBT_UI_TYPE_CUSTOM_GFX
</SECTION>


<SECTION>
<FILE>wavereplay</FILE>
<TITLE>GstBtWaveReplay</TITLE>
Expand Down
8 changes: 5 additions & 3 deletions src/lib/gst/ui.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@
G_BEGIN_DECLS

/**
* GstBtUiCustomGfxResponse: returned by GstBtUiCustomGfxInterface::request
* GstBtUiCustomGfxResponse:
*
* @version: set to 0
* @width: width of returned image in pixels
* @height: height of returned image in pixels
* @data: ABGR data, width*height guints
*
* Data returned by GstBtUiCustomGfxInterface::request
*/
typedef struct GstBtUiCustomGfxResponse {
guint version; // set to 0
Expand All @@ -45,7 +47,7 @@ G_DECLARE_INTERFACE (GstBtUiCustomGfx, gstbt_ui_custom_gfx, GSTBT_UI, CUSTOM_GFX
GObject)

/**
* GstBtUiCustomGfxInterface
* GstBtUiCustomGfxInterface:
*
* @request: Return the machine's current custom gfx image.
* Ownership of the returned object isn't transferred, so cached data
Expand All @@ -54,7 +56,7 @@ G_DECLARE_INTERFACE (GstBtUiCustomGfx, gstbt_ui_custom_gfx, GSTBT_UI, CUSTOM_GFX
* The actual rendering of the image may be done here.
*
* May return NULL; in that case, Buzztrax's standard gfx are used.
*/
*/
struct _GstBtUiCustomGfxInterface {
GTypeInterface parent;

Expand Down

0 comments on commit 56722c6

Please sign in to comment.