mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-25 17:55:35 +00:00
210 lines
8.5 KiB
XML
210 lines
8.5 KiB
XML
<Type Name="Handle" FullName="Rsvg.Handle">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public class Handle : GLib.Opaque" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>rsvg-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>2.16.0.0</AssemblyVersion>
|
|
</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>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>GLib.Opaque</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
</Interfaces>
|
|
<Members>
|
|
<Member MemberName="Close">
|
|
<MemberSignature Language="C#" Value="public bool Close ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Close, to indicate that loading the image is complete. </summary>
|
|
<returns>
|
|
<see langword="true" /> if the loader closed successfully, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This will return <see langword="true" /> if the loader closed successfully.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Free">
|
|
<MemberSignature Language="C#" Value="public void Free ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Frees handle.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Handle (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
|
<remarks>
|
|
<block subset="none" type="note">
|
|
<para>This is not a wrapper around rsvg_handle_new_from_data. This just passes the pointer as the pointer to the Glib object. It probably requires the pointer to be already initialized (like the result of rsvg_handle_new_from_data is).</para>
|
|
</block>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Handle ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Returns a new rsvg handle.</summary>
|
|
<remarks>This handle can be used for dynamically loading an image. You need to feed it data using <see cref="M:Rsvg.Handle.Write()" />, then call <see cref="M:Rsvg.Handle.Close()" /> when done. No more than one image can be loaded with one handle.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Pixbuf">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The pixbuf loaded by handle.</summary>
|
|
<value>a <see cref="T:Gdk.Pixbuf" /></value>
|
|
<remarks>If insufficient data has been read to create the pixbuf, or an error occurred in loading, then <see langword="null" /> will be returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Dpi">
|
|
<MemberSignature Language="C#" Value="public double Dpi { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Sets the DPI for the all future outgoing pixbufs.</summary>
|
|
<value> Dots Per Inch (aka Pixels Per Inch)</value>
|
|
<remarks>Common values are 72, 90, and 300 DPI. Passing a number <= 0 to dpi will reset the DPI to whatever the default value happens to be.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="NewGz">
|
|
<MemberSignature Language="C#" Value="public static Rsvg.Handle NewGz ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Rsvg.Handle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>See <see cref="C:Rsvg.Handle" />, except that this will handle GZipped SVGs (svgz)</summary>
|
|
<returns>a <see cref="T:Rsvg.Handle" /></returns>
|
|
<remarks>Use the returned handle identically to how you use a handle returned from <see cref="C:Rsvg.Handle" /></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Write">
|
|
<MemberSignature Language="C#" Value="public bool Write (byte[] buf, ulong count);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="buf" Type="System.Byte[]" />
|
|
<Parameter Name="count" Type="System.UInt64" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads the next <paramref name="count" /> bytes</summary>
|
|
<param name="buf"> Pointer to svg data</param>
|
|
<param name="count"> length of the <paramref name="buf" /> buffer in bytes</param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>This will return <see langword="true" /> if the data was loaded successful, and <see langword="false" /> if an error occurred. In the latter case, the loader will be closed, and will not accept further writes.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Desc">
|
|
<MemberSignature Language="C#" Value="public string Desc { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>a <see cref="T:System.String" /></value>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Title">
|
|
<MemberSignature Language="C#" Value="public string Title { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>a <see cref="T:System.String" /></value>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Path">
|
|
<MemberSignature Language="C#" Value="public void Path (string d, string id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="d" Type="System.String" />
|
|
<Parameter Name="id" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="d">a <see cref="T:System.String" /></param>
|
|
<param name="id">a <see cref="T:System.String" /></param>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetSizeCallback" Deprecated="true">
|
|
<MemberSignature Language="C#" Value="public void SetSizeCallback (Rsvg.SizeFunc size_func, IntPtr user_data, IntPtr user_data_destroy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="size_func" Type="Rsvg.SizeFunc" />
|
|
<Parameter Name="user_data" Type="System.IntPtr" />
|
|
<Parameter Name="user_data_destroy" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="size_func">a <see cref="T:Rsvg.SizeFunc" /></param>
|
|
<param name="user_data">a <see cref="T:System.IntPtr" /></param>
|
|
<param name="user_data_destroy">a <see cref="T:System.IntPtr" /></param>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SizeCallback">
|
|
<MemberSignature Language="C#" Value="public Rsvg.SizeFunc SizeCallback { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Rsvg.SizeFunc</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>a <see cref="T:Rsvg.SizeFunc" /></value>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|