.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Pango 3pm"
.TH pods::SDL::Pango 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Pango \- Text rendering engine
.SH CATEGORY
.IX Header "CATEGORY"
Pango
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 9
\& use SDL;
\& use SDL::Color;
\& use SDL::Surface;
\& use SDL::Overlay;
\& use SDL::Rect;
\& use SDL::Video;
\& use SDL::PixelFormat;
\& use SDL::Pango;
\& use SDL::Pango::Context;
\& 
\& SDL::Pango::init();
\& 
\& my $context = SDL::Pango::Context\->new;
\& SDL::Pango::set_default_color($context, 0xA7C344FF, 0);
\& SDL::Pango::set_markup($context, \*(AqHello <b>W<span foreground="red">o</span><i>r</i><u>l</u>d</b>!\*(Aq, \-1);
\&
\& SDL::init(SDL_INIT_VIDEO);
\& 
\& my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
\& my $bg      = SDL::Video::map_RGB($display\->format, 0x12, 0x22, 0x45);
\& SDL::Video::fill_rect($display, SDL::Rect\->new(0, 0, 640, 480), $bg);
\&
\& my $surface = SDL::Pango::create_surface_draw($context);
\& SDL::Video::blit_surface($surface, SDL::Rect\->new(0, 0, 640, 480), $display, SDL::Rect\->new(0, 0, 640, 480));
\& 
\& SDL::Video::update_rect($display, 0, 0, 0, 0);
\& SDL::delay(2000);
.Ve
.SH CONSTANTS
.IX Header "CONSTANTS"
The constants are exported by default. You can avoid this by doing:
.PP
.Vb 1
\& use SDL::Pango ();
.Ve
.PP
and access them directly:
.PP
.Vb 1
\& SDL::Pango::SDLPANGO_DIRECTION_NEUTRAL;
.Ve
.PP
or by choosing the export tags below:
.PP
Export tag: ':align'
.IP SDLPANGO_ALIGN_LEFT 4
.IX Item "SDLPANGO_ALIGN_LEFT"
Left alignment
.IP SDLPANGO_ALIGN_CENTER 4
.IX Item "SDLPANGO_ALIGN_CENTER"
Centered
.IP SDLPANGO_ALIGN_RIGHT 4
.IX Item "SDLPANGO_ALIGN_RIGHT"
Right alignment
.PP
Export tag: ':direction'
.IP SDLPANGO_DIRECTION_LTR 4
.IX Item "SDLPANGO_DIRECTION_LTR"
Left to right
.IP SDLPANGO_DIRECTION_RTL 4
.IX Item "SDLPANGO_DIRECTION_RTL"
Right to left
.IP SDLPANGO_DIRECTION_WEAK_LTR 4
.IX Item "SDLPANGO_DIRECTION_WEAK_LTR"
Left to right (weak)
.IP SDLPANGO_DIRECTION_WEAK_RTL 4
.IX Item "SDLPANGO_DIRECTION_WEAK_RTL"
Right to left (weak)
.IP SDLPANGO_DIRECTION_NEUTRAL 4
.IX Item "SDLPANGO_DIRECTION_NEUTRAL"
Neutral
.SH METHODS
.IX Header "METHODS"
.SS init
.IX Subsection "init"
.Vb 1
\& SDL::Pango::init();
.Ve
.PP
Initialize the Glib and Pango API. This must be called before using other functions in this library, excepting SDL::Pango::was_init. 
SDL does not have to be initialized before this call.
.PP
Returns: always \f(CW0\fR.
.SS was_init
.IX Subsection "was_init"
.Vb 1
\& my $was_init = SDL::Pango::was_init();
.Ve
.PP
Query the initialization status of the Glib and Pango API. You may, of course, use this before SDL::Pango::init to avoid initializing twice 
in a row.
.PP
Returns: Non-zero when already initialized. Zero when not initialized.
.SS set_default_color
.IX Subsection "set_default_color"
.Vb 2
\& SDL::Pango::set_default_color($context, $foreground, $background);
\& SDL::Pango::set_default_color($context, $r1, $g1, $b1, $a1, $r2, $g2, $b2, $a2);
.Ve
.PP
Sets default foreground and background color when rendering text and markup.
.PP
You can call it with either 2 color-parameters (32\-bit RRGGBBAA values), or with 4 separate values for foreground and 4 separate values for 
background.
.SS set_minimum_size
.IX Subsection "set_minimum_size"
.Vb 1
\& SDL::Pango::set_minimum_size($context, $width, $height);
.Ve
.PP
Sets the minimum size of the drawing rectangle.
.SS set_text
.IX Subsection "set_text"
.Vb 2
\& SDL::Pango::set_text($context, $text, $length);
\& SDL::Pango::set_text($context, $text, $length, $alignment);
.Ve
.PP
Set plain text to context. Text must be utf\-8. \f(CW$length\fR chars will be rendered, pass \f(CW\-1\fR to render the whole text.
.PP
\&\f(CW$alignment\fR can be:
.IP \(bu 4
SDLPANGO_ALIGN_LEFT (default)
.IP \(bu 4
SDLPANGO_ALIGN_CENTER
.IP \(bu 4
SDLPANGO_ALIGN_RIGHT
.SS set_markup
.IX Subsection "set_markup"
.Vb 1
\& SDL::Pango::set_markup($context, $text, $length);
.Ve
.PP
Set markup text to context. Text must be utf\-8. \f(CW$length\fR chars will be rendered, pass \f(CW\-1\fR to render the whole text.
.PP
See PangoMarkupFormat <http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html> for a description about the markup format.
.SS get_layout_width
.IX Subsection "get_layout_width"
.Vb 1
\& my $w = SDL::Pango::get_layout_width($context);
.Ve
.PP
Returns the width of the resulting surface of the given text/markup for this context.
.SS get_layout_height
.IX Subsection "get_layout_height"
.Vb 1
\& my $h = SDL::Pango::get_layout_height($context);
.Ve
.PP
Returns the height of the resulting surface of the given text/markup for this context.
.SS set_base_direction
.IX Subsection "set_base_direction"
.Vb 1
\& SDL::Pango::set_base_direction($context, $direction);
.Ve
.PP
Sets the direction of the text to either left-to-right or right-to-left.
.PP
See "CONSTANTS".
.SS set_dpi
.IX Subsection "set_dpi"
.Vb 1
\& SDL::Pango::set_dpi($context, $dpi_x, $dpi_y);
.Ve
.PP
Sets the DPI (dots per inch) for this context. Default is \f(CW96\fR.
.SS set_language
.IX Subsection "set_language"
.Vb 1
\& SDL::Pango::set_language($context, $language);
.Ve
.PP
Sets the language name for this context.
.PP
See ISO639\-2 <http://www.loc.gov/standards/iso639-2/php/code_list.php>.
.PP
Example:
.PP
.Vb 1
\& SDL::Pango::set_language($context, "en");
.Ve
.SS draw
.IX Subsection "draw"
.Vb 1
\& SDL::Pango::draw($context, $display, $x, $y);
.Ve
.PP
Draws the text or markup to an existing surface at position \f(CW$x\fR/\f(CW$y\fR.
.SS set_surface_create_args
.IX Subsection "set_surface_create_args"
.Vb 1
\& SDL::Pango::set_surface_create_args($context, $flags, $bits, $r_mask, $g_mask, $b_mask, $a_mask);
.Ve
.PP
Sets the argument that are used when creating a surface via SDL::Pango::create_surface_draw.
.PP
Example:
.PP
.Vb 9
\& SDL::Pango::set_surface_create_args(
\&     $context, 
\&     SDL_SWSURFACE, 
\&     32, 
\&     0xFF000000, 
\&     0x00FF0000, 
\&     0x0000FF00, 
\&     0x000000FF
\& );
.Ve
.SS create_surface_draw
.IX Subsection "create_surface_draw"
.Vb 1
\& my $surface = SDL::Pango::create_surface_draw($context);
.Ve
.PP
Creates a new surface and draws the text/markup. You can specify the attributes of the surfaces using SDL::Pango::set_surface_create_args.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SDL::Pango::Context, SDL::Video, SDL::Surface, SDL::TTF