diff options
Diffstat (limited to 'libs/cairo-1.16.0/doc/public/xml/cairo-svg.xml')
| -rw-r--r-- | libs/cairo-1.16.0/doc/public/xml/cairo-svg.xml | 425 |
1 files changed, 425 insertions, 0 deletions
diff --git a/libs/cairo-1.16.0/doc/public/xml/cairo-svg.xml b/libs/cairo-1.16.0/doc/public/xml/cairo-svg.xml new file mode 100644 index 0000000..60d81dd --- /dev/null +++ b/libs/cairo-1.16.0/doc/public/xml/cairo-svg.xml @@ -0,0 +1,425 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<refentry id="cairo-SVG-Surfaces"> +<refmeta> +<refentrytitle role="top_of_page" id="cairo-SVG-Surfaces.top_of_page">SVG Surfaces</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo>CAIRO Library</refmiscinfo> +</refmeta> +<refnamediv> +<refname>SVG Surfaces</refname> +<refpurpose>Rendering SVG documents</refpurpose> +</refnamediv> + +<refsect1 id="cairo-SVG-Surfaces.functions" role="functions_proto"> +<title role="functions_proto.title">Functions</title> +<informaltable pgwide="1" frame="none"> +<tgroup cols="2"> +<colspec colname="functions_return" colwidth="150px"/> +<colspec colname="functions_name"/> +<tbody> +<row><entry role="function_type"><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * +</entry><entry role="function_name"><link linkend="cairo-svg-surface-create">cairo_svg_surface_create</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type"><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * +</entry><entry role="function_name"><link linkend="cairo-svg-surface-create-for-stream">cairo_svg_surface_create_for_stream</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type"><link linkend="cairo-svg-unit-t"><returnvalue>cairo_svg_unit_t</returnvalue></link> +</entry><entry role="function_name"><link linkend="cairo-svg-surface-get-document-unit">cairo_svg_surface_get_document_unit</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link> +</entry><entry role="function_name"><link linkend="cairo-svg-surface-set-document-unit">cairo_svg_surface_set_document_unit</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link> +</entry><entry role="function_name"><link linkend="cairo-svg-surface-restrict-to-version">cairo_svg_surface_restrict_to_version</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link> +</entry><entry role="function_name"><link linkend="cairo-svg-get-versions">cairo_svg_get_versions</link> <phrase role="c_punctuation">()</phrase></entry></row> +<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link> * +</entry><entry role="function_name"><link linkend="cairo-svg-version-to-string">cairo_svg_version_to_string</link> <phrase role="c_punctuation">()</phrase></entry></row> + +</tbody> +</tgroup> +</informaltable> +</refsect1> +<refsect1 id="cairo-SVG-Surfaces.other" role="other_proto"> +<title role="other_proto.title">Types and Values</title> +<informaltable role="enum_members_table" pgwide="1" frame="none"> +<tgroup cols="2"> +<colspec colname="name" colwidth="150px"/> +<colspec colname="description"/> +<tbody> +<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="CAIRO-HAS-SVG-SURFACE:CAPS">CAIRO_HAS_SVG_SURFACE</link></entry></row> +<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="cairo-svg-version-t">cairo_svg_version_t</link></entry></row> +<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="cairo-svg-unit-t">cairo_svg_unit_t</link></entry></row> + +</tbody> +</tgroup> +</informaltable> +</refsect1> + + +<refsect1 id="cairo-SVG-Surfaces.description" role="desc"> +<title role="desc.title">Description</title> +<para>The SVG surface is used to render cairo graphics to +SVG files and is a multi-page vector surface backend.</para> + +</refsect1> +<refsect1 id="cairo-SVG-Surfaces.functions_details" role="details"> +<title role="details.title">Functions</title> +<refsect2 id="cairo-svg-surface-create" role="function" condition="since:1.2"> +<title>cairo_svg_surface_create ()</title> +<indexterm zone="cairo-svg-surface-create" role="1.2"><primary sortas="svg_surface_create">cairo_svg_surface_create</primary></indexterm> +<programlisting language="C"><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * +cairo_svg_surface_create (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>, + <parameter><link linkend="double"><type>double</type></link> width_in_points</parameter>, + <parameter><link linkend="double"><type>double</type></link> height_in_points</parameter>);</programlisting> +<para>Creates a SVG surface of the specified size in points to be written +to <parameter>filename</parameter> +.</para> +<para>The SVG surface backend recognizes the following MIME types for the +data attached to a surface (see <link linkend="cairo-surface-set-mime-data"><function>cairo_surface_set_mime_data()</function></link>) when +it is used as a source pattern for drawing on this surface: +<link linkend="CAIRO-MIME-TYPE-JPEG:CAPS"><literal>CAIRO_MIME_TYPE_JPEG</literal></link>, <link linkend="CAIRO-MIME-TYPE-PNG:CAPS"><literal>CAIRO_MIME_TYPE_PNG</literal></link>, +<link linkend="CAIRO-MIME-TYPE-URI:CAPS"><literal>CAIRO_MIME_TYPE_URI</literal></link>. If any of them is specified, the SVG backend +emits a href with the content of MIME data instead of a surface +snapshot (PNG, Base64-encoded) in the corresponding image tag.</para> +<para>The unofficial MIME type <link linkend="CAIRO-MIME-TYPE-URI:CAPS"><literal>CAIRO_MIME_TYPE_URI</literal></link> is examined +first. If present, the URI is emitted as is: assuring the +correctness of URI is left to the client code.</para> +<para>If <link linkend="CAIRO-MIME-TYPE-URI:CAPS"><literal>CAIRO_MIME_TYPE_URI</literal></link> is not present, but <link linkend="CAIRO-MIME-TYPE-JPEG:CAPS"><literal>CAIRO_MIME_TYPE_JPEG</literal></link> +or <link linkend="CAIRO-MIME-TYPE-PNG:CAPS"><literal>CAIRO_MIME_TYPE_PNG</literal></link> is specified, the corresponding data is +Base64-encoded and emitted.</para> +<para>If <link linkend="CAIRO-MIME-TYPE-UNIQUE-ID:CAPS"><literal>CAIRO_MIME_TYPE_UNIQUE_ID</literal></link> is present, all surfaces with the same +unique identifier will only be embedded once.</para> +<refsect3 id="cairo-svg-surface-create.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>filename</para></entry> +<entry role="parameter_description"><para>a filename for the SVG output (must be writable), <link linkend="NULL:CAPS"><literal>NULL</literal></link> may be +used to specify no output. This will generate a SVG surface that +may be queried and used as a source, without generating a +temporary file.</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>width_in_points</para></entry> +<entry role="parameter_description"><para>width of the surface, in points (1 point == 1/72.0 inch)</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>height_in_points</para></entry> +<entry role="parameter_description"><para>height of the surface, in points (1 point == 1/72.0 inch)</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><refsect3 id="cairo-svg-surface-create.returns" role="returns"> +<title>Returns</title> +<para> a pointer to the newly created surface. The caller +owns the surface and should call <link linkend="cairo-surface-destroy"><function>cairo_surface_destroy()</function></link> when done +with it.</para> +<para>This function always returns a valid pointer, but it will return a +pointer to a "nil" surface if an error such as out of memory +occurs. You can use <link linkend="cairo-surface-status"><function>cairo_surface_status()</function></link> to check for this.</para> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-surface-create-for-stream" role="function" condition="since:1.2"> +<title>cairo_svg_surface_create_for_stream ()</title> +<indexterm zone="cairo-svg-surface-create-for-stream" role="1.2"><primary sortas="svg_surface_create_for_stream">cairo_svg_surface_create_for_stream</primary></indexterm> +<programlisting language="C"><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * +cairo_svg_surface_create_for_stream (<parameter><link linkend="cairo-write-func-t"><type>cairo_write_func_t</type></link> write_func</parameter>, + <parameter><link linkend="void"><type>void</type></link> *closure</parameter>, + <parameter><link linkend="double"><type>double</type></link> width_in_points</parameter>, + <parameter><link linkend="double"><type>double</type></link> height_in_points</parameter>);</programlisting> +<para>Creates a SVG surface of the specified size in points to be written +incrementally to the stream represented by <parameter>write_func</parameter> + and <parameter>closure</parameter> +.</para> +<refsect3 id="cairo-svg-surface-create-for-stream.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>write_func</para></entry> +<entry role="parameter_description"><para>a <link linkend="cairo-write-func-t"><type>cairo_write_func_t</type></link> to accept the output data, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> +to indicate a no-op <parameter>write_func</parameter> +. With a no-op <parameter>write_func</parameter> +, +the surface may be queried or used as a source without +generating any temporary files.</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>closure</para></entry> +<entry role="parameter_description"><para>the closure argument for <parameter>write_func</parameter> +</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>width_in_points</para></entry> +<entry role="parameter_description"><para>width of the surface, in points (1 point == 1/72.0 inch)</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>height_in_points</para></entry> +<entry role="parameter_description"><para>height of the surface, in points (1 point == 1/72.0 inch)</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><refsect3 id="cairo-svg-surface-create-for-stream.returns" role="returns"> +<title>Returns</title> +<para> a pointer to the newly created surface. The caller +owns the surface and should call <link linkend="cairo-surface-destroy"><function>cairo_surface_destroy()</function></link> when done +with it.</para> +<para>This function always returns a valid pointer, but it will return a +pointer to a "nil" surface if an error such as out of memory +occurs. You can use <link linkend="cairo-surface-status"><function>cairo_surface_status()</function></link> to check for this.</para> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-surface-get-document-unit" role="function" condition="since:1.16"> +<title>cairo_svg_surface_get_document_unit ()</title> +<indexterm zone="cairo-svg-surface-get-document-unit" role="1.16"><primary sortas="svg_surface_get_document_unit">cairo_svg_surface_get_document_unit</primary></indexterm> +<programlisting language="C"><link linkend="cairo-svg-unit-t"><returnvalue>cairo_svg_unit_t</returnvalue></link> +cairo_svg_surface_get_document_unit (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting> +<para>Get the unit of the SVG surface.</para> +<para>If the surface passed as an argument is not a SVG surface, the function +sets the error status to CAIRO_STATUS_SURFACE_TYPE_MISMATCH and returns +CAIRO_SVG_UNIT_USER.</para> +<refsect3 id="cairo-svg-surface-get-document-unit.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>surface</para></entry> +<entry role="parameter_description"><para>a SVG <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link></para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><refsect3 id="cairo-svg-surface-get-document-unit.returns" role="returns"> +<title>Returns</title> +<para> the SVG unit of the SVG surface.</para> +</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2> +<refsect2 id="cairo-svg-surface-set-document-unit" role="function" condition="since:1.16"> +<title>cairo_svg_surface_set_document_unit ()</title> +<indexterm zone="cairo-svg-surface-set-document-unit" role="1.16"><primary sortas="svg_surface_set_document_unit">cairo_svg_surface_set_document_unit</primary></indexterm> +<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link> +cairo_svg_surface_set_document_unit (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>, + <parameter><link linkend="cairo-svg-unit-t"><type>cairo_svg_unit_t</type></link> unit</parameter>);</programlisting> +<para>Use the specified unit for the width and height of the generated SVG file. +See <link linkend="cairo-svg-unit-t"><type>cairo_svg_unit_t</type></link> for a list of available unit values that can be used +here.</para> +<para>This function can be called at any time before generating the SVG file.</para> +<para>However to minimize the risk of ambiguities it's recommended to call it +before any drawing operations have been performed on the given surface, to +make it clearer what the unit used in the drawing operations is.</para> +<para>The simplest way to do this is to call this function immediately after +creating the SVG surface.</para> +<para>Note if this function is never called, the default unit for SVG documents +generated by cairo will be "pt". This is for historical reasons.</para> +<refsect3 id="cairo-svg-surface-set-document-unit.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>surface</para></entry> +<entry role="parameter_description"><para>a SVG <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link></para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>unit</para></entry> +<entry role="parameter_description"><para>SVG unit</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2> +<refsect2 id="cairo-svg-surface-restrict-to-version" role="function" condition="since:1.2"> +<title>cairo_svg_surface_restrict_to_version ()</title> +<indexterm zone="cairo-svg-surface-restrict-to-version" role="1.2"><primary sortas="svg_surface_restrict_to_version">cairo_svg_surface_restrict_to_version</primary></indexterm> +<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link> +cairo_svg_surface_restrict_to_version (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>, + <parameter><link linkend="cairo-svg-version-t"><type>cairo_svg_version_t</type></link> version</parameter>);</programlisting> +<para>Restricts the generated SVG file to <parameter>version</parameter> +. See <link linkend="cairo-svg-get-versions"><function>cairo_svg_get_versions()</function></link> +for a list of available version values that can be used here.</para> +<para>This function should only be called before any drawing operations +have been performed on the given surface. The simplest way to do +this is to call this function immediately after creating the +surface.</para> +<refsect3 id="cairo-svg-surface-restrict-to-version.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>surface</para></entry> +<entry role="parameter_description"><para>a SVG <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link></para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>version</para></entry> +<entry role="parameter_description"><para>SVG version</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-get-versions" role="function" condition="since:1.2"> +<title>cairo_svg_get_versions ()</title> +<indexterm zone="cairo-svg-get-versions" role="1.2"><primary sortas="svg_get_versions">cairo_svg_get_versions</primary></indexterm> +<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link> +cairo_svg_get_versions (<parameter><link linkend="cairo-svg-version-t"><type>cairo_svg_version_t</type></link> const **versions</parameter>, + <parameter><link linkend="int"><type>int</type></link> *num_versions</parameter>);</programlisting> +<para>Used to retrieve the list of supported versions. See +<link linkend="cairo-svg-surface-restrict-to-version"><function>cairo_svg_surface_restrict_to_version()</function></link>.</para> +<refsect3 id="cairo-svg-get-versions.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>versions</para></entry> +<entry role="parameter_description"><para>supported version list</para></entry> +<entry role="parameter_annotations"></entry></row> +<row><entry role="parameter_name"><para>num_versions</para></entry> +<entry role="parameter_description"><para>list length</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-version-to-string" role="function" condition="since:1.2"> +<title>cairo_svg_version_to_string ()</title> +<indexterm zone="cairo-svg-version-to-string" role="1.2"><primary sortas="svg_version_to_string">cairo_svg_version_to_string</primary></indexterm> +<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link> * +cairo_svg_version_to_string (<parameter><link linkend="cairo-svg-version-t"><type>cairo_svg_version_t</type></link> version</parameter>);</programlisting> +<para>Get the string representation of the given <parameter>version</parameter> + id. This function +will return <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>version</parameter> + isn't valid. See <link linkend="cairo-svg-get-versions"><function>cairo_svg_get_versions()</function></link> +for a way to get the list of valid version ids.</para> +<refsect3 id="cairo-svg-version-to-string.parameters" role="parameters"> +<title>Parameters</title> +<informaltable role="parameters_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="parameters_name" colwidth="150px"/> +<colspec colname="parameters_description"/> +<colspec colname="parameters_annotations" colwidth="200px"/> +<tbody> +<row><entry role="parameter_name"><para>version</para></entry> +<entry role="parameter_description"><para>a version id</para></entry> +<entry role="parameter_annotations"></entry></row> +</tbody></tgroup></informaltable> +</refsect3><refsect3 id="cairo-svg-version-to-string.returns" role="returns"> +<title>Returns</title> +<para> the string associated to given version.</para> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> + +</refsect1> +<refsect1 id="cairo-SVG-Surfaces.other_details" role="details"> +<title role="details.title">Types and Values</title> +<refsect2 id="CAIRO-HAS-SVG-SURFACE:CAPS" role="macro" condition="since:1.2"> +<title>CAIRO_HAS_SVG_SURFACE</title> +<indexterm zone="CAIRO-HAS-SVG-SURFACE:CAPS" role="1.2"><primary sortas="HAS_SVG_SURFACE">CAIRO_HAS_SVG_SURFACE</primary></indexterm> +<programlisting language="C">#define CAIRO_HAS_SVG_SURFACE 1 +</programlisting> +<para>Defined if the SVG surface backend is available. +This macro can be used to conditionally compile backend-specific code.</para> +<para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-version-t" role="enum" condition="since:1.2"> +<title>enum cairo_svg_version_t</title> +<indexterm zone="cairo-svg-version-t" role="1.2"><primary sortas="svg_version_t">cairo_svg_version_t</primary></indexterm> +<para><link linkend="cairo-svg-version-t"><type>cairo_svg_version_t</type></link> is used to describe the version number of the SVG +specification that a generated SVG file will conform to.</para> +<refsect3 id="cairo-svg-version-t.members" role="enum_members"> +<title>Members</title> +<informaltable role="enum_members_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="enum_members_name" colwidth="300px"/> +<colspec colname="enum_members_description"/> +<colspec colname="enum_members_annotations" colwidth="200px"/> +<tbody> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-VERSION-1-1:CAPS">CAIRO_SVG_VERSION_1_1</para></entry> +<entry role="enum_member_description"><para>The version 1.1 of the SVG specification. (Since 1.2)</para> +</entry> +<entry role="enum_member_annotations"></entry> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-VERSION-1-2:CAPS">CAIRO_SVG_VERSION_1_2</para></entry> +<entry role="enum_member_description"><para>The version 1.2 of the SVG specification. (Since 1.2)</para> +</entry> +<entry role="enum_member_annotations"></entry> +</row> +</tbody></tgroup></informaltable> +</refsect3><para role="since">Since: <link linkend="api-index-1.2">1.2</link></para></refsect2> +<refsect2 id="cairo-svg-unit-t" role="enum" condition="since:1.16"> +<title>enum cairo_svg_unit_t</title> +<indexterm zone="cairo-svg-unit-t" role="1.16"><primary sortas="svg_unit_t">cairo_svg_unit_t</primary></indexterm> +<para><parameter>CAIRO_SVG_UNIT_USER</parameter> +: User unit, a value in the current coordinate system. + If used in the root element for the initial coordinate systems it + corresponds to pixels. (Since 1.16) +<parameter>CAIRO_SVG_UNIT_EM</parameter> +: The size of the element's font. (Since 1.16) +<parameter>CAIRO_SVG_UNIT_EX</parameter> +: The x-height of the element’s font. (Since 1.16) +<parameter>CAIRO_SVG_UNIT_PX</parameter> +: Pixels (1px = 1/96th of 1in). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_IN</parameter> +: Inches (1in = 2.54cm = 96px). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_CM</parameter> +: Centimeters (1cm = 96px/2.54). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_MM</parameter> +: Millimeters (1mm = 1/10th of 1cm). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_PT</parameter> +: Points (1pt = 1/72th of 1in). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_PC</parameter> +: Picas (1pc = 1/6th of 1in). (Since 1.16) +<parameter>CAIRO_SVG_UNIT_PERCENT</parameter> +: Percent, a value that is some fraction of another + reference value. (Since 1.16)</para> +<para><link linkend="cairo-svg-unit-t"><type>cairo_svg_unit_t</type></link> is used to describe the units valid for coordinates and +lengths in the SVG specification.</para> +<para>See also: +https://www.w3.org/TR/SVG/coords.html<link linkend="Units"><type>Units</type></link> +https://www.w3.org/TR/SVG/types.html<link linkend="DataTypeLength"><type>DataTypeLength</type></link> +https://www.w3.org/TR/css-values-3/<link linkend="lengths"><type>lengths</type></link></para> +<refsect3 id="cairo-svg-unit-t.members" role="enum_members"> +<title>Members</title> +<informaltable role="enum_members_table" pgwide="1" frame="none"> +<tgroup cols="3"> +<colspec colname="enum_members_name" colwidth="300px"/> +<colspec colname="enum_members_description"/> +<colspec colname="enum_members_annotations" colwidth="200px"/> +<tbody> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-USER:CAPS">CAIRO_SVG_UNIT_USER</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-EM:CAPS">CAIRO_SVG_UNIT_EM</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-EX:CAPS">CAIRO_SVG_UNIT_EX</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-PX:CAPS">CAIRO_SVG_UNIT_PX</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-IN:CAPS">CAIRO_SVG_UNIT_IN</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-CM:CAPS">CAIRO_SVG_UNIT_CM</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-MM:CAPS">CAIRO_SVG_UNIT_MM</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-PT:CAPS">CAIRO_SVG_UNIT_PT</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-PC:CAPS">CAIRO_SVG_UNIT_PC</para></entry> +<entry /><entry /> +</row> +<row role="constant"><entry role="enum_member_name"><para id="CAIRO-SVG-UNIT-PERCENT:CAPS">CAIRO_SVG_UNIT_PERCENT</para></entry> +<entry /><entry /> +</row> +</tbody></tgroup></informaltable> +</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2> + +</refsect1> +<refsect1 id="cairo-SVG-Surfaces.see-also"> +<title>See Also</title> +<para><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link></para> + +</refsect1> + +</refentry> |