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
|
<Type Name="PixbufAnimationIter" FullName="Gdk.PixbufAnimationIter">
<TypeSignature Language="C#" Maintainer="auto" Value="public class PixbufAnimationIter : GLib.Object" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PixbufAnimationIter extends GLib.Object" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>
An iterator used by <see cref="T:Gdk.PixbufAnimation" /> for displaying animations by stepping through frames.
</summary>
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected PixbufAnimationIter ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Protected constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PixbufAnimationIter (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Advance">
<MemberSignature Language="C#" Value="public bool Advance (IntPtr current_time);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Advance(native int current_time) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="current_time" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="current_time">A <see cref="T:IntPtr" />, pointer to a C time object</param>
<summary>
Possibly advances an animation to a new frame. Chooses the frame based
on the start time passed to
<see cref="M:Gdk.PixbufAnimation.GetIter" />.
</summary>
<returns>A <see cref="T:System.Boolean" />, true if the image may need updating.</returns>
<remarks>
<p>
<paramref name="current_time" /> would normally come from g_get_current_time(), and
must be greater than or equal to the time passed to
<see cref="M:Gdk.PixbufAnimation.GetIter" />, and must increase or remain
unchanged each time this method is
called. That is, you can't go backward in time; animations only
play forward.
</p>
<p>
As a shortcut, pass <see langword="null" /> for the current time and g_get_current_time()
will be invoked on your behalf. So you only need to explicitly pass
<paramref name="current_time" /> if you're doing something odd like playing the animation
at double speed.
</p>
<p>
If this method returns false, there's no need to update the animation
display, assuming the display had been rendered prior to advancing;
if true, you need to call
<see cref="P:Gdk.PixbufAnimationIter.Pixbuf" /> and update the
display with the new pixbuf.
</p>
</remarks>
</Docs>
</Member>
<Member MemberName="DelayTime">
<MemberSignature Language="C#" Value="public int DelayTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 DelayTime" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the number of milliseconds the current pixbuf should be displayed,
or -1 if the current pixbuf should be displayed forever.
</summary>
<value>A <see cref="T:System.Int32" />, delay time in milliseconds (thousandths of a second)</value>
<remarks>
g_timeout_add() (FIXME: this doesn't seem to be bound)
conveniently takes a timeout in milliseconds, so you can use a timeout
to schedule the next update.
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.PixbufAnimationIter" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnCurrentlyLoadingFrame">
<MemberSignature Language="C#" Value="public bool OnCurrentlyLoadingFrame ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool OnCurrentlyLoadingFrame() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Used to determine how to respond to the
<see cref="E:Gdk.PixbufLoader.AreaUpdated" /> signal
when loading an animation.
<see cref="E:Gdk.PixbufLoader.AreaUpdated" /> is emitted
for an area of the frame currently streaming into the loader. So if
you're on the currently loading frame, you need to redraw the
screen for the updated area.
</summary>
<returns>A <see cref="T:System.Boolean" />, true if the frame we're on is partially loaded, or the last frame</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Pixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Pixbuf Pixbuf" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the current pixbuf which should be displayed; the pixbuf will
be the same size as the animation itself
(<see cref="M:Gdk.PixbufAnimation.GetWidth" />, <see cref="M:Gdk.PixbufAnimation.GetHeight" />). This pixbuf should be displayed
for <see cref="P:Gdk.PixbufAnimation.DelayTime" /> milliseconds. The caller
of this function does not own a reference to the returned pixbuf;
the returned pixbuf will become invalid when the iterator advances
to the next frame, which may happen anytime you call
<see cref="M:Gdk.PixbufAnimationIter.Advance" />. Copy the pixbuf to keep it
(don't just add a reference), as it may get recycled as you advance
the iterator.
</summary>
<value>A <see cref="T:Gdk.Pixbuf" /></value>
<remarks />
</Docs>
</Member>
</Members>
</Type>
|
