244 lines
No EOL
14 KiB
XML
244 lines
No EOL
14 KiB
XML
<Type Name="Pixbuf" FullName="Rsvg.Pixbuf">
|
|
<TypeSignature Language="C#" Value="public class Pixbuf" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>rsvg-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<AssemblyCulture>neutral</AssemblyCulture>
|
|
<Attributes />
|
|
</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>Utility/Convenience Functions for creating a <see cref="T:Gdk.PixBuf" /> from SVG. </summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="FromFileAtZoomWithMax">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtZoomWithMax (string file_name, double x_zoom, double y_zoom, int max_width, int max_height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="x_zoom" Type="System.Double" />
|
|
<Parameter Name="y_zoom" Type="System.Double" />
|
|
<Parameter Name="max_width" Type="System.Int32" />
|
|
<Parameter Name="max_height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="x_zoom" />, <paramref name="y_zoom" />, <paramref name="max_width" /> and <paramref name="max_height" />.</summary>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="x_zoom"> The horizontal zoom factor</param>
|
|
<param name="y_zoom"> The vertical zoom factor</param>
|
|
<param name="max_width"> The requested max width</param>
|
|
<param name="max_height"> The requested max height</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated by the file by a factor of <paramref name="x_zoom" /> and <paramref name="y_zoom" />. If the resulting pixbuf would be larger than <paramref name="max_width" /> / <paramref name="max_height" /> it is uniformly scaled down to fit in that rectangle. If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFile">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFile (string file_name);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> and returns it.</summary>
|
|
<param name="file_name"> A file name</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtSize">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtSize (string file_name, int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="height" /> and <paramref name="width" />.</summary>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="width"> The new width, or -1</param>
|
|
<param name="height"> The new height, or -1</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated to the new size indicated by <paramref name="width" /> and <paramref name="height" />. If either of these are -1, then the default size of the image being loaded is used. If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtMaxSize">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtMaxSize (string file_name, int max_width, int max_height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="max_width" Type="System.Int32" />
|
|
<Parameter Name="max_height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="max_width" /> and <paramref name="max_height" />.</summary>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="max_width"> The requested max width</param>
|
|
<param name="max_height"> The requested max height</param>
|
|
<returns>A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is uniformly scaled so that the it fits into a rectangle of size <paramref name="max_width" /> * <paramref name="max_height" />. If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtZoom">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtZoom (string file_name, double x_zoom, double y_zoom);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="x_zoom" Type="System.Double" />
|
|
<Parameter Name="y_zoom" Type="System.Double" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="x_zoom" /> and <paramref name="y_zoom" />.</summary>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="x_zoom"> The horizontal zoom factor</param>
|
|
<param name="y_zoom"> The vertical zoom factor</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated by the file by a factor of <paramref name="x_zoom" /> and <paramref name="y_zoom" />. If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:Rsvg.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtMaxSizeEx">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtMaxSizeEx (Rsvg.Handle handle, string file_name, int max_width, int max_height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Rsvg.Handle" />
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="max_width" Type="System.Int32" />
|
|
<Parameter Name="max_height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="max_width" /> and <paramref name="max_height" />.</summary>
|
|
<param name="handle"> The <see cref="T:Rsvg.Handle" /> you wish to render with (either normal or gzipped)</param>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="max_width"> The requested max width</param>
|
|
<param name="max_height"> The requested max height</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is uniformly scaled so that the it fits into a rectangle of size <paramref name="max_width" /> * <paramref name="max_height" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtSizeEx">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtSizeEx (Rsvg.Handle handle, string file_name, int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Rsvg.Handle" />
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new <see cref="T:Gdk.Pixbuf" /> from <paramref name="file_name" /> at <paramref name="width" /> and <paramref name="height" /></summary>
|
|
<param name="handle"> The <see cref="T:Rsvg.Handle" /> you wish to render with (either normal or gzipped)</param>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="width"> The new width, or -1</param>
|
|
<param name="height"> The new height, or -1</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated to the new size indicated by width and height. If either of these are -1, then the default size of the image being loaded is used. If an error occurred <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtZoomEx">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtZoomEx (Rsvg.Handle handle, string file_name, double x_zoom, double y_zoom);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Rsvg.Handle" />
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="x_zoom" Type="System.Double" />
|
|
<Parameter Name="y_zoom" Type="System.Double" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new GdkPixbuf from <paramref name="file_name" /> at <paramref name="x_zoom" /> and <paramref name="y_zoom" />.</summary>
|
|
<param name="handle"> The <see cref="T:Rsvg.Handle" /> you wish to render with (either normal or gzipped)</param>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="x_zoom"> The horizontal zoom factor</param>
|
|
<param name="y_zoom"> The vertical zoom factor</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated by the file by a factor of <paramref name="x_zoom" /> and <paramref name="y_zoom" />. </remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileEx">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileEx (Rsvg.Handle handle, string file_name);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Rsvg.Handle" />
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new GdkPixbuf from <paramref name="file_name" />.</summary>
|
|
<param name="handle"> The <see cref="T:Rsvg.Handle" /> you wish to render with (either normal or gzipped)</param>
|
|
<param name="file_name"> A file name</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>If an error occurred, error is set and <see langword="null" /> is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromFileAtZoomWithMaxEx">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromFileAtZoomWithMaxEx (Rsvg.Handle handle, string file_name, double x_zoom, double y_zoom, int max_width, int max_height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Rsvg.Handle" />
|
|
<Parameter Name="file_name" Type="System.String" />
|
|
<Parameter Name="x_zoom" Type="System.Double" />
|
|
<Parameter Name="y_zoom" Type="System.Double" />
|
|
<Parameter Name="max_width" Type="System.Int32" />
|
|
<Parameter Name="max_height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads a new GdkPixbuf from file_name</summary>
|
|
<param name="handle"> The <see cref="T:Rsvg.Handle" /> you wish to render with (either normal or gzipped)</param>
|
|
<param name="file_name"> A file name</param>
|
|
<param name="x_zoom"> The horizontal zoom factor</param>
|
|
<param name="y_zoom"> The vertical zoom factor</param>
|
|
<param name="max_width"> The requested max width</param>
|
|
<param name="max_height"> The requested max height</param>
|
|
<returns> A newly allocated <see cref="T:Gdk.Pixbuf" />, or <see langword="null" /></returns>
|
|
<remarks>This pixbuf is scaled from the size indicated by the file by a factor of <paramref name="x_zoom" /> and <paramref name="y_zoom" />. If the resulting pixbuf would be larger than <paramref name="max_width" /> / <paramref name="max_height" /> it is uniformly scaled down to fit in that rectangle. </remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |