isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-25 04:22:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/cogl-pango: Make use of gi-docgen annotations

Browse Source 
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2708>
This commit is contained in:
Bilal Elmoussaoui 2022-11-22 12:54:04 +01:00
parent 7bf07d2980
commit 3393db942a
2 changed files with 11 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cogl/cogl-pango/cogl-pango-fontmap.c
View File

@ -26,14 +26,6 @@
* SOFTWARE. * SOFTWARE.
*/ */
/**
* SECTION:cogl-pango
* @short_description: COGL-based text rendering using Pango
*
* FIXME
*
*/
#include "cogl-config.h" #include "cogl-config.h"
/* This is needed to get the Pango headers to export stuff needed to /* This is needed to get the Pango headers to export stuff needed to

22
cogl/cogl-pango/cogl-pango.h
View File

@ -82,9 +82,9 @@ cogl_pango_font_map_new (void);
* cogl_pango_font_map_create_context: * cogl_pango_font_map_create_context:
* @font_map: a #CoglPangoFontMap * @font_map: a #CoglPangoFontMap
* *
* Create a #PangoContext for the given @font_map. * Create a [class@Pango.Context] for the given @font_map.
* *
* Returns: (transfer full): the newly created context: free with g_object_unref(). * Returns: (transfer full): the newly created context: free with [method@GObject.Object.unref].
*/ */
COGL_EXPORT PangoContext * COGL_EXPORT PangoContext *
cogl_pango_font_map_create_context (CoglPangoFontMap *font_map); cogl_pango_font_map_create_context (CoglPangoFontMap *font_map);
@ -95,8 +95,10 @@ cogl_pango_font_map_create_context (CoglPangoFontMap *font_map);
* @dpi: The resolution in "dots per inch". (Physical inches aren't * @dpi: The resolution in "dots per inch". (Physical inches aren't
* actually involved; the terminology is conventional.) * actually involved; the terminology is conventional.)
* *
* Sets the resolution for the @font_map. This is a scale factor * Sets the resolution for the @font_map.
* between points specified in a #PangoFontDescription and Cogl units. *
* This is a scale factor between points specified in a
* [struct@Pango.FontDescription] and Cogl units.
* The default value is %96, meaning that a 10 point font will be 13 * The default value is %96, meaning that a 10 point font will be 13
* units high. (10 * 96. / 72. = 13.3). * units high. (10 * 96. / 72. = 13.3).
* *
@ -138,7 +140,7 @@ cogl_pango_ensure_glyph_cache_for_layout (PangoLayout *layout);
* @value: %TRUE to enable the use of mipmapping * @value: %TRUE to enable the use of mipmapping
* *
* Sets whether the renderer for the passed font map should use * Sets whether the renderer for the passed font map should use
* mipmapping when rendering a #PangoLayout. * mipmapping when rendering a [class@Pango.Layout].
* *
* Since: 1.0 * Since: 1.0
*/ */
@ -150,7 +152,7 @@ cogl_pango_font_map_set_use_mipmapping (CoglPangoFontMap *font_map,
* cogl_pango_font_map_get_use_mipmapping: * cogl_pango_font_map_get_use_mipmapping:
* @font_map: a #CoglPangoFontMap * @font_map: a #CoglPangoFontMap
* *
* Retrieves whether the #CoglPangoRenderer used by @font_map will use * Retrieves whether the [class@CoglPango.Renderer] used by @font_map will use
* mipmapping when rendering the glyphs. * mipmapping when rendering the glyphs.
* *
* Return value: %TRUE if mipmapping is used, %FALSE otherwise. * Return value: %TRUE if mipmapping is used, %FALSE otherwise.
@ -164,7 +166,7 @@ cogl_pango_font_map_get_use_mipmapping (CoglPangoFontMap *font_map);
* cogl_pango_font_map_get_renderer: * cogl_pango_font_map_get_renderer:
* @font_map: a #CoglPangoFontMap * @font_map: a #CoglPangoFontMap
* *
* Retrieves the #CoglPangoRenderer for the passed @font_map. * Retrieves the [class@CoglPango.Renderer] for the passed @font_map.
* *
* Return value: (transfer none): a #PangoRenderer * Return value: (transfer none): a #PangoRenderer
* *
@ -182,8 +184,7 @@ cogl_pango_font_map_get_renderer (CoglPangoFontMap *font_map);
* @color: color to use when rendering the layout * @color: color to use when rendering the layout
* *
* Draws a solidly coloured @layout on the given @framebuffer at (@x, * Draws a solidly coloured @layout on the given @framebuffer at (@x,
* @y) within the @framebuffer<!-- -->'s current model-view coordinate * @y) within the `framebuffer`'s current model-view coordinate space.
* space.
* *
* Since: 1.14 * Since: 1.14
*/ */
@ -203,8 +204,7 @@ cogl_pango_show_layout (CoglFramebuffer *framebuffer,
* @color: color to use when rendering the line * @color: color to use when rendering the line
* *
* Draws a solidly coloured @line on the given @framebuffer at (@x, * Draws a solidly coloured @line on the given @framebuffer at (@x,
* @y) within the @framebuffer<!-- -->'s current model-view coordinate * @y) within the `framebuffer`'s current model-view coordinate space.
* space.
* *
* Since: 1.14 * Since: 1.14
*/ */