Skip to content

Commit

Permalink
Another small doc update.
Browse files Browse the repository at this point in the history
We'll need to align this with teh GObject naming conventions to fit
better (will be followup change).
  • Loading branch information
Stefan Sauer committed Feb 11, 2024
1 parent faf0647 commit 350b6c5
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/reference/bt-gst/buzztrax-gst-docs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
<xi:include href="xml/childbin.xml"/>
<xi:include href="xml/propertymeta.xml"/>
<xi:include href="xml/tempo.xml"/>
<xi:include href="xml/ui.xml"/>
</chapter>

<chapter>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/bt-gst/buzztrax-gst-sections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -474,14 +474,14 @@ gstbt_tone_conversion_tuning_get_type
<SECTION>
<FILE>ui</FILE>
<TITLE>GstBtUi</TITLE>
GstBtUiCustomGfx
GstBtUiCustomGfxInterface
GstBtUiCustomGfxResponse
gstbt_ui_custom_gfx_request
GstBtUiCustomGfx
<SUBSECTION Standard>
GSTBT_UI_TYPE_CUSTOM_GFX
</SECTION>


<SECTION>
<FILE>wavereplay</FILE>
<TITLE>GstBtWaveReplay</TITLE>
Expand Down
15 changes: 7 additions & 8 deletions src/lib/gst/ui.c
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,20 @@
*
* Allows a machine to supply its own graphics to be drawn over the machine in
* the Machine View.
*
* SIGNALS:
*
* gstbt-ui-gfx-invalidated() [G_SIGNAL_ACTION]
*
* Machines generally don't have to do anything in response to this signal, but
* they should emit it when something happens that should change the image,
* i.e. by the machine on a parameter change.
*/

#include "ui.h"

G_DEFINE_INTERFACE(GstBtUiCustomGfx, gstbt_ui_custom_gfx, G_TYPE_OBJECT)

static void gstbt_ui_custom_gfx_default_init (GstBtUiCustomGfxInterface *iface) {
/**
* GstBtUiCustomGfx::gstbt-ui-custom-gfx-invalidated:
*
* Machines generally don't have to do anything in response to this signal, but
* they should emit it when something happens that should change the image,
* i.e. by the machine on a parameter change.
*/
g_signal_new (
"gstbt-ui-custom-gfx-invalidated",
G_OBJECT_CLASS_TYPE(iface),
Expand Down
10 changes: 8 additions & 2 deletions src/lib/gst/ui.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ G_BEGIN_DECLS

/**
* GstBtUiCustomGfxResponse:
*
* @version: set to 0
* @width: width of returned image in pixels
* @height: height of returned image in pixels
Expand All @@ -47,15 +46,22 @@ G_DECLARE_INTERFACE (GstBtUiCustomGfx, gstbt_ui_custom_gfx, GSTBT_UI, CUSTOM_GFX
GObject)

/**
* GstBtUiCustomGfxInterface:
* GstBtUiCustomGfx:
*
* Opaque interface handle.
*/
/**
* GstBtUiCustomGfxInterface:
* @parent: parent type
* @request: Return the machine's current custom gfx image.
* Ownership of the returned object isn't transferred, so cached data
* can be used (both response structure and image data.)
*
* The actual rendering of the image may be done here.
*
* May return NULL; in that case, Buzztrax's standard gfx are used.
*
* Interface structure.
*/
struct _GstBtUiCustomGfxInterface {
GTypeInterface parent;
Expand Down

0 comments on commit 350b6c5

Please sign in to comment.