← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/cogl/xml/cogl-bitmap.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/cogl/xml/cogl-bitmap.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version "1.0.8">
5
 
]>
6
 
<refentry id="cogl-Bitmaps">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="cogl-Bitmaps.top_of_page">Bitmaps</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>COGL Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>Bitmaps</refname>
15
 
<refpurpose>Fuctions for loading images but not directly
16
 
                    into textures</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="cogl-Bitmaps.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
<link linkend="CoglHandle">CoglHandle</link>          <link linkend="cogl-bitmap-new-from-file">cogl_bitmap_new_from_file</link>           (const <link linkend="gchar">gchar</link> *filename,
24
 
                                                         <link linkend="GError">GError</link> **error);
25
 
<link linkend="gboolean">gboolean</link>            <link linkend="cogl-bitmap-get-size-from-file">cogl_bitmap_get_size_from_file</link>      (const <link linkend="gchar">gchar</link> *filename,
26
 
                                                         <link linkend="gint">gint</link> *width,
27
 
                                                         <link linkend="gint">gint</link> *height);
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
<refsect1 id="cogl-Bitmaps.description" role="desc">
40
 
<title role="desc.title">Description</title>
41
 
<para>
42
 
Cogl allows loading image data into memory as CoglBitmaps without
43
 
loading them immediately into GPU textures.</para>
44
 
<para>
45
 
</para>
46
 
</refsect1>
47
 
 
48
 
<refsect1 id="cogl-Bitmaps.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="cogl-bitmap-new-from-file" role="function" condition="since:1.0">
51
 
<title>cogl_bitmap_new_from_file ()</title>
52
 
<indexterm zone="cogl-bitmap-new-from-file" role="1.0"><primary sortas="bitmap_new_from_file">cogl_bitmap_new_from_file</primary></indexterm><programlisting><link linkend="CoglHandle">CoglHandle</link>          cogl_bitmap_new_from_file           (const <link linkend="gchar">gchar</link> *filename,
53
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
54
 
<para>
55
 
Loads an image file from disk. This function can be safely called from
56
 
within a thread.</para>
57
 
<para>
58
 
</para><variablelist role="params">
59
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
60
 
<listitem><simpara> the file to load.
61
 
</simpara></listitem></varlistentry>
62
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
63
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
64
 
</simpara></listitem></varlistentry>
65
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="CoglHandle"><type>CoglHandle</type></link> to the new loaded image data, or
66
 
  <link linkend="COGL-INVALID-HANDLE--CAPS"><literal>COGL_INVALID_HANDLE</literal></link> if loading the image failed.
67
 
 
68
 
</simpara></listitem></varlistentry>
69
 
</variablelist><para role="since">Since 1.0</para></refsect2>
70
 
<refsect2 id="cogl-bitmap-get-size-from-file" role="function" condition="since:1.0">
71
 
<title>cogl_bitmap_get_size_from_file ()</title>
72
 
<indexterm zone="cogl-bitmap-get-size-from-file" role="1.0"><primary sortas="bitmap_get_size_from_file">cogl_bitmap_get_size_from_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            cogl_bitmap_get_size_from_file      (const <link linkend="gchar">gchar</link> *filename,
73
 
                                                         <link linkend="gint">gint</link> *width,
74
 
                                                         <link linkend="gint">gint</link> *height);</programlisting>
75
 
<para>
76
 
Parses an image file enough to extract the width and height
77
 
of the bitmap.</para>
78
 
<para>
79
 
</para><variablelist role="params">
80
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
81
 
<listitem><simpara> the file to check
82
 
</simpara></listitem></varlistentry>
83
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
84
 
<listitem><simpara> return location for the bitmap width
85
 
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
87
 
<listitem><simpara> return location for the bitmap height
88
 
</simpara></listitem></varlistentry>
89
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the image was successfully parsed
90
 
 
91
 
</simpara></listitem></varlistentry>
92
 
</variablelist><para role="since">Since 1.0</para></refsect2>
93
 
 
94
 
</refsect1>
95
 
 
96
 
 
97
 
 
98
 
 
99
 
</refentry>