File: classCairo_1_1QuartzSurface.html

package info (click to toggle)
cairomm 1.8.4-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 4,952 kB
  • ctags: 1,655
  • sloc: sh: 10,132; cpp: 5,157; perl: 204; makefile: 159
file content (240 lines) | stat: -rw-r--r-- 12,625 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
        <title>cairomm: Cairo::QuartzSurface Class Reference</title>
        <link href="cairomm.css" rel="stylesheet" type="text/css">
    </head>
<body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceCairo.html">Cairo</a>::<a class="el" href="classCairo_1_1QuartzSurface.html">QuartzSurface</a>
  </div>
</div>
<div class="contents">
<h1>Cairo::QuartzSurface Class Reference</h1><!-- doxytag: class="Cairo::QuartzSurface" --><!-- doxytag: inherits="Cairo::Surface" -->A <a class="el" href="classCairo_1_1QuartzSurface.html" title="A QuartzSurface provides a way to render within Apple Mac OS X.">QuartzSurface</a> provides a way to render within Apple Mac OS X.  
<a href="#_details">More...</a>
<p>
Inherits <a class="el" href="classCairo_1_1Surface.html">Cairo::Surface</a>.
<p>

<p>
<a href="classCairo_1_1QuartzSurface-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1QuartzSurface.html#14fa4758ee13f117df028455c434c950">QuartzSurface</a> (cairo_surface_t*<a class="el" href="classCairo_1_1Surface.html#d176eb7343b5902df3c19f9f56e59fb4">cobject</a>, bool has_reference=false)</td></tr>

<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a C++ wrapper for the C instance.  <a href="#14fa4758ee13f117df028455c434c950"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1QuartzSurface.html#bc137ab5872ea08b8cb487a026b87321">~QuartzSurface</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">CGContextRef&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1QuartzSurface.html#db20c77cc96f4716ef0b3634d3689d63">get_cg_context</a> () const </td></tr>

<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the CGContextRef associated with this surface, or NULL if none.  <a href="#db20c77cc96f4716ef0b3634d3689d63"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1QuartzSurface.html">QuartzSurface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1QuartzSurface.html#c8d11fe174bd9e4480da10a1696d6297">create</a> (CGContextRef cg_context, int width, int height)</td></tr>

<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a cairo surface that targets the given CGContext.  <a href="#c8d11fe174bd9e4480da10a1696d6297"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt; <a class="el" href="classCairo_1_1QuartzSurface.html">QuartzSurface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1QuartzSurface.html#d83e737c882fb32811a1adcb4832721f">create</a> (<a class="el" href="namespaceCairo.html#d3f86970e1bd354b263303c9b8759166">Format</a> format, int width, int height)</td></tr>

<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a device-independent-bitmap surface not associated with any particular existing surface or device context.  <a href="#d83e737c882fb32811a1adcb4832721f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classCairo_1_1QuartzSurface.html" title="A QuartzSurface provides a way to render within Apple Mac OS X.">QuartzSurface</a> provides a way to render within Apple Mac OS X. 
<p>
If you want to draw to the screen within a Mac OS X application, you should use this <a class="el" href="classCairo_1_1Surface.html" title="A cairo surface represents an image, either as the destination of a drawing operation...">Surface</a> type.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>For this <a class="el" href="classCairo_1_1Surface.html" title="A cairo surface represents an image, either as the destination of a drawing operation...">Surface</a> to be available, cairo must have been compiled with (native) Quartz support (requires <a class="el" href="namespaceCairo.html">Cairo</a> &gt; 1.4.0) </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="14fa4758ee13f117df028455c434c950"></a><!-- doxytag: member="Cairo::QuartzSurface::QuartzSurface" ref="14fa4758ee13f117df028455c434c950" args="(cairo_surface_t *cobject, bool has_reference=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::QuartzSurface::QuartzSurface           </td>
          <td>(</td>
          <td class="paramtype">cairo_surface_t *&#160;</td>
          <td class="paramname"> <em>cobject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>has_reference</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a C++ wrapper for the C instance. 
<p>
This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr&lt;&gt; is a reference-counting shared smartpointer.">RefPtr</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>cobject</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>has_reference</em>&#160;</td><td>whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="bc137ab5872ea08b8cb487a026b87321"></a><!-- doxytag: member="Cairo::QuartzSurface::~QuartzSurface" ref="bc137ab5872ea08b8cb487a026b87321" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Cairo::QuartzSurface::~QuartzSurface           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d83e737c882fb32811a1adcb4832721f"></a><!-- doxytag: member="Cairo::QuartzSurface::create" ref="d83e737c882fb32811a1adcb4832721f" args="(Format format, int width, int height)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt;<a class="el" href="classCairo_1_1QuartzSurface.html">QuartzSurface</a>&gt; Cairo::QuartzSurface::create           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceCairo.html#d3f86970e1bd354b263303c9b8759166">Format</a>&#160;</td>
          <td class="paramname"> <em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>height</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a device-independent-bitmap surface not associated with any particular existing surface or device context. 
<p>
The created bitmap will be unititialized.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>format</em>&#160;</td><td>format of pixels in the surface to create </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>width</em>&#160;</td><td>width of the surface, in pixels </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>height</em>&#160;</td><td>height of the surface, in pixels </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created surface </dd></dl>

</div>
</div><p>
<a class="anchor" name="c8d11fe174bd9e4480da10a1696d6297"></a><!-- doxytag: member="Cairo::QuartzSurface::create" ref="c8d11fe174bd9e4480da10a1696d6297" args="(CGContextRef cg_context, int width, int height)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>&lt;<a class="el" href="classCairo_1_1QuartzSurface.html">QuartzSurface</a>&gt; Cairo::QuartzSurface::create           </td>
          <td>(</td>
          <td class="paramtype">CGContextRef&#160;</td>
          <td class="paramname"> <em>cg_context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"> <em>height</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a cairo surface that targets the given CGContext. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>cg_context</em>&#160;</td><td>the CGContext to create a surface for </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created surface </dd></dl>

</div>
</div><p>
<a class="anchor" name="db20c77cc96f4716ef0b3634d3689d63"></a><!-- doxytag: member="Cairo::QuartzSurface::get_cg_context" ref="db20c77cc96f4716ef0b3634d3689d63" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CGContextRef Cairo::QuartzSurface::get_cg_context           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the CGContextRef associated with this surface, or NULL if none. 
<p>
Also returns NULL if the surface is not a Quartz surface.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>CGContextRef or NULL if no CGContextRef available. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cairomm/quartz_surface.h</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Aug 13 11:40:14 2009 for cairomm by&#160;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>