mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-16 19:44:45 +02:00
1607 lines
78 KiB
XML
1607 lines
78 KiB
XML
<Type Name="Pixbuf" FullName="Gdk.Pixbuf">
|
|
<TypeSignature Language="C#" Maintainer="miguel" Value="public class Pixbuf : GLib.Object, GLib.IIcon" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Pixbuf extends GLib.Object implements class GLib.IIcon, class GLib.IWrapper" />
|
|
<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>
|
|
<Interface>
|
|
<InterfaceName>GLib.IIcon</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<summary>In memory image handling and representation.</summary>
|
|
<remarks>
|
|
<para>
|
|
The <see cref="T:Gdk.Pixbuf" /> class is used to represent an image in
|
|
memory, typically on the client side (this is different from <see cref="T:Gdk.Pixmap" /> that represents a server-side image). The in-memory representation uses either a three
|
|
byte RGB representation or a four byte RGBA representation.
|
|
</para>
|
|
<para>
|
|
Pixbufs can be created from a number of sources: image files
|
|
in an assorted set of file formats (png, tiff, jpg, gif, xpm,
|
|
pcx, ico, xpm, xbm); Drawables (which can be windows on the X
|
|
server, or off-screen images in the X server) or in-memory
|
|
images.
|
|
</para>
|
|
<para>
|
|
A pixbuf can be rendered, scaled or composited into another
|
|
pixbuf, into a window on the X server, or on a drawable in the
|
|
X server. Various rendering methods are provided for this
|
|
purpose.
|
|
</para>
|
|
<para>
|
|
Pixbufs can also be saved to a number of different file
|
|
formats.
|
|
</para>
|
|
<para>An example that composites two images next to each other.
|
|
<example><code lang="C#">
|
|
// Compile with: mcs -pkg:gtk-sharp PixmapComposite.cs
|
|
// Usage: PixmapComposite.exe image-1.jpg image-2.jpg composite.jpg
|
|
using Gdk;
|
|
using System;
|
|
|
|
public class PixmapComposite
|
|
{
|
|
public static void Main (string [] args)
|
|
{
|
|
// Check arguments, this takes three.
|
|
if (args.Length < 3)
|
|
throw new Exception ("USAGE: image1Filename image2Filename "
|
|
+ "compositeFilename");
|
|
|
|
// Figure out the output type
|
|
string type = "jpeg";
|
|
|
|
if (args [2].ToLower ().EndsWith (".jpg"))
|
|
type = "jpeg";
|
|
else if (args [2].ToLower ().EndsWith (".png"))
|
|
type = "png";
|
|
else
|
|
throw new Exception ("Only JPG and PNG images are supported for "
|
|
+ "the composite image");
|
|
|
|
// Init the system
|
|
Gdk.Global.InitCheck(ref args);
|
|
|
|
// Load the images
|
|
Pixbuf image1 = new Pixbuf (args [0]);
|
|
Pixbuf image2 = new Pixbuf (args [1]);
|
|
|
|
// Create the composite image
|
|
Colorspace colorspace = image1.Colorspace;
|
|
bool hasAlpha = image1.HasAlpha;
|
|
int bitsPerSample = image1.BitsPerSample;
|
|
Pixbuf composite = new Pixbuf (colorspace,
|
|
hasAlpha,
|
|
bitsPerSample,
|
|
image1.Width + image2.Width,
|
|
image1.Height);
|
|
|
|
// Composite the images on the central one
|
|
image1.Composite (composite,
|
|
0, 0, image1.Width, image1.Height,
|
|
0.0, 0.0, 1.0, 1.0,
|
|
InterpType.Hyper,
|
|
255);
|
|
image2.Composite (composite,
|
|
image1.Width, 0, image2.Width, image2.Height,
|
|
image1.Width, 0.0, 1.0, 1.0,
|
|
InterpType.Hyper,
|
|
255);
|
|
|
|
// Write out the image as a JPG
|
|
composite.Save (args [2], type);
|
|
}
|
|
}
|
|
</code></example></para>
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] buffer);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] buffer) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="buffer" Type="System.Byte[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="buffer">a <see cref="T:System.Byte[]" /> containing the image in one of the formats recognized by Pixbuf (png, tiff, jpeg, etc).</param>
|
|
<summary>Makes a new Pixbuf object from a <see cref="T:System.Byte[]" /> containing an encoded image.</summary>
|
|
<remarks>Useful for creating a Pixbuf from an image file in memory.
|
|
|
|
<example><code lang="C#">
|
|
/* buffer containing an image */
|
|
System.Byte[] buffer = new System.Byte[256];
|
|
|
|
/* create a pixbuf from the buffer as if it was a file */
|
|
Gdk.Pixbuf pb = new Gdk.Pixbuf(buffer);
|
|
</code></example></remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (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=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.IO.Stream stream);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="stream">a <see cref="T:System.IO.Stream" /> containing the image</param>
|
|
<summary>Makes a new Pixbuf object from a <see cref="T:System.IO.Stream" />.</summary>
|
|
<remarks>Useful for creating a Pixbuf from an image file that resides in a stream.
|
|
|
|
<example><code lang="C#">
|
|
/* buffer containing an image */
|
|
System.Byte[] buffer = new System.Byte[256];
|
|
|
|
/* create a memory stream to the buffer */
|
|
System.IO.MemoryStream memorystream = new System.IO.MemoryStream(buffer);
|
|
|
|
/* create a pixbuf from the stream as if it was a file */
|
|
Gdk.Pixbuf pb = new Gdk.Pixbuf(memorystream);
|
|
</code></example></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (string filename);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">Filename with the image</param>
|
|
<summary>Creates Pixbuf from image file.</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a new pixbuf by loading an image from a file. The
|
|
file format is detected automatically (multiple formats are
|
|
supported: JPG, PNG, TIFF, XPM, XBM). If the file is not
|
|
found, a <see cref="T:GLib.GException" /> will be thrown.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (string[] data);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] data) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.String[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">a <see cref="T:System.String[]" /></param>
|
|
<summary>Public constructor.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (GLib.InputStream stream, GLib.Cancellable cancellable);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class GLib.InputStream stream, class GLib.Cancellable cancellable) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="GLib.InputStream" />
|
|
<Parameter Name="cancellable" Type="GLib.Cancellable" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="stream">To be added.</param>
|
|
<param name="cancellable">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] data, bool copy_pixels);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] data, bool copy_pixels) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">To be added.</param>
|
|
<param name="copy_pixels">To be added.</param>
|
|
<summary>Constructor for pixbufs that that have embedded images created with the gdk-pixbuf-source program.</summary>
|
|
<remarks>This is used to create pixbufs from images that have been embedded using the gdk-pixbuf-csource command line tool. </remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.Reflection.Assembly assembly, string resource);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Reflection.Assembly assembly, string resource) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="assembly">The <see cref="T:System.Reflection.Assembly" /> that contains the image.
|
|
<para>
|
|
If the value is <see langword="null" />, the image will be looked up on the calling assembly.</para></param>
|
|
<param name="resource">The name given as the resource in the assembly</param>
|
|
<summary>Constructor for images embedded in an assembly</summary>
|
|
<remarks>
|
|
<para>
|
|
This method is used to construct a <see cref="T:Gdk.Pixbuf" /> from an embedded resource in an assembly.
|
|
</para>
|
|
<para>
|
|
Typically this is used when application developers want to distribute images in a single executable.
|
|
</para>
|
|
|
|
If the assembly parameter is <see langword="null" />, the image will be looked up on the calling assembly.
|
|
|
|
<para>
|
|
For example:
|
|
</para><example><code lang="C#">
|
|
Gdk.Pixbuf p = new Pixbuf (null, "image.jpg");
|
|
</code></example><para>Compile with:</para><example><code lang="Compilation">
|
|
mcs -resource:image.jpg sample.cs
|
|
</code></example></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] buffer, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] buffer, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="buffer" Type="System.Byte[]" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="buffer">a <see cref="T:System.Byte[]" /> containing the image</param>
|
|
<param name="width"> a <see cref="T:System.Int32" /> specifying the required width</param>
|
|
<param name="height"> a <see cref="T:System.Int32" /> specifying the required height</param>
|
|
<summary>Makes a new Pixbuf object from a <see cref="T:System.Byte[]" /> with a given size.</summary>
|
|
<remarks>Useful for creating a Pixbuf with a specific size from an image file in memory.
|
|
|
|
<example><code lang="C#">
|
|
/* buffer containing an image */
|
|
System.Byte[] buffer = new System.Byte[256];
|
|
|
|
/* create a pixbuf from the buffer as if it was a file */
|
|
Gdk.Pixbuf pb = new Gdk.Pixbuf(buffer, 10, 10);
|
|
</code></example></remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (int data_length, byte[] data, bool copy_pixels);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 data_length, unsigned int8[] data, bool copy_pixels) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data_length" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data_length">The length in bytes of the data to be read.</param>
|
|
<param name="data">A serialized <see cref="T:Gdk.Pixdata" /> structure, generated with <see cref="M:Gdk.Pixdata.Serialize" />.</param>
|
|
<param name="copy_pixels">If true, the "data" parameter will be copied and the copy will be used for the Pixbuf. If false, the data will be used as is and the Pixbuf will be dependent on it.</param>
|
|
<summary>Construct a pixbuf from a serialized <see cref="T:Gdk.Pixdata" /> structure</summary>
|
|
<remarks>None</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (int data_length, void* data, bool copy_pixels);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 data_length, void* data, bool copy_pixels) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data_length" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.Void*" />
|
|
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data_length">The length in bytes of the data to be read.</param>
|
|
<param name="data">The raw data representing the serialized <see cref="T:Gdk.Pixdata" /> structure.</param>
|
|
<param name="copy_pixels">If true, the "data" parameter will be copied and the copy will be used for the Pixbuf. If false, the data will be used as is and the Pixbuf will be dependent on it.</param>
|
|
<summary>Construct a pixbuf from a serialized <see cref="T:Gdk.Pixdata" /> structure.</summary>
|
|
<remarks>None</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.IO.Stream stream, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="stream">a <see cref="T:System.IO.Stream" /> containing the image</param>
|
|
<param name="width"> a <see cref="T:System.Int32" /> specifying the required width</param>
|
|
<param name="height"> a <see cref="T:System.Int32" /> specifying the required height</param>
|
|
<summary>Makes a new Pixbuf object from a <see cref="T:System.IO.Stream" /> with a given size.</summary>
|
|
<remarks>Useful for creating a Pixbuf with a specific size from an image file that resides in a stream.
|
|
|
|
<example><code lang="C#">
|
|
/* buffer containing an image */
|
|
System.Byte[] buffer = new System.Byte[256];
|
|
|
|
/* create a memory stream to the buffer */
|
|
System.IO.MemoryStream memorystream = new System.IO.MemoryStream(buffer);
|
|
|
|
/* create a pixbuf from the stream as if it was a file */
|
|
Gdk.Pixbuf pb = new Gdk.Pixbuf(memorystream, 10, 10);
|
|
</code></example></remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (string filename, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">a <see cref="T:System.String" /></param>
|
|
<param name="width">a <see cref="T:System.Int32" /></param>
|
|
<param name="height">a <see cref="T:System.Int32" /></param>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.Reflection.Assembly assembly, string resource, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Reflection.Assembly assembly, string resource, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
|
|
<Parameter Name="resource" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="assembly">The <see cref="T:System.Reflection.Assembly" /> that contains the image.
|
|
<para>
|
|
If the value is <see langword="null" />, the image will be looked up on the calling assembly.</para></param>
|
|
<param name="resource">The name given as the resource in the assembly</param>
|
|
<param name="width">The required width for the pixbuf</param>
|
|
<param name="height">The required height for the pixbuf</param>
|
|
<summary>Constructor for images embedded in an assembly when a specific size is required.</summary>
|
|
<remarks>
|
|
<para>
|
|
This method is used to construct a <see cref="T:Gdk.Pixbuf" /> from an embedded resource in an assembly with a specific size.
|
|
</para>
|
|
<para>
|
|
Typically this is used when application developers want to distribute images in a single executable.
|
|
</para>
|
|
|
|
If the assembly parameter is <see langword="null" />, the image will be looked up on the calling assembly.
|
|
|
|
<para>
|
|
For example:
|
|
</para><example><code lang="C#">
|
|
Gdk.Pixbuf p = new Pixbuf (null, "image.jpg", 10, 10);
|
|
</code></example><para>Compile with:</para><example><code lang="Compilation">
|
|
mcs -resource:image.jpg sample.cs
|
|
</code></example></remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (string filename, int width, int height, bool preserve_aspect_ratio);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename, int32 width, int32 height, bool preserve_aspect_ratio) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="preserve_aspect_ratio" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">a <see cref="T:System.String" /></param>
|
|
<param name="width">a <see cref="T:System.Int32" /></param>
|
|
<param name="height">a <see cref="T:System.Int32" /></param>
|
|
<param name="preserve_aspect_ratio">a <see cref="T:System.Boolean" /></param>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.6" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (Gdk.Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Gdk.Colorspace colorspace, bool has_alpha, int32 bits_per_sample, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="colorspace" Type="Gdk.Colorspace" />
|
|
<Parameter Name="has_alpha" Type="System.Boolean" />
|
|
<Parameter Name="bits_per_sample" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="colorspace">The colorspace (<see cref="T:Gdk.Colorspace" />)</param>
|
|
<param name="has_alpha">Whether the image should have transparency information.</param>
|
|
<param name="bits_per_sample">Number of bits per color sample.</param>
|
|
<param name="width">Width of image in pixels.</param>
|
|
<param name="height">Height of image in pixels.</param>
|
|
<summary>Constructor</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a new <see cref="T:Gdk.Pixbuf" /> structure and allocates a buffer
|
|
for it. The buffer has an optimal rowstride. Note that the
|
|
buffer is not cleared; you will have to fill it completely
|
|
yourself.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (Gdk.Pixbuf src_pixbuf, int src_x, int src_y, int width, int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gdk.Pixbuf src_pixbuf, int32 src_x, int32 src_y, int32 width, int32 height) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="src_pixbuf" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="src_pixbuf">The containing <see cref="T:Gdk.Pixbuf" />.</param>
|
|
<param name="src_x">X coord in src_pixbuf</param>
|
|
<param name="src_y">Y coord in src_pixbuf</param>
|
|
<param name="width">Width of region in src_pixbuf</param>
|
|
<param name="height">Height of region in src_pixbuf</param>
|
|
<summary>Creates a sub-Pixbuf from an existing one.</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a new pixbuf which represents a sub-region of
|
|
<paramref name="src_pixbuf" />. The new pixbuf shares its
|
|
pixels with the original pixbuf, so writing to one affects
|
|
both. The new pixbuf holds a reference to <paramref name="src_pixbuf" />, so <paramref name="src_pixbuf" /> will
|
|
not be finalized until the new pixbuf is finalized.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (GLib.InputStream stream, int width, int height, bool preserve_aspect_ratio, GLib.Cancellable cancellable);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class GLib.InputStream stream, int32 width, int32 height, bool preserve_aspect_ratio, class GLib.Cancellable cancellable) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="GLib.InputStream" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="preserve_aspect_ratio" Type="System.Boolean" />
|
|
<Parameter Name="cancellable" Type="GLib.Cancellable" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="stream">To be added.</param>
|
|
<param name="width">To be added.</param>
|
|
<param name="height">To be added.</param>
|
|
<param name="preserve_aspect_ratio">To be added.</param>
|
|
<param name="cancellable">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] data, bool has_alpha, int bits_per_sample, int width, int height, int rowstride);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] data, bool has_alpha, int32 bits_per_sample, int32 width, int32 height, int32 rowstride) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="has_alpha" Type="System.Boolean" />
|
|
<Parameter Name="bits_per_sample" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="rowstride" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">The data that contains the image in RGB or RGBA format.</param>
|
|
<param name="has_alpha">Whether the data contains an alpha channel (RGBA format).</param>
|
|
<param name="bits_per_sample">Currently only 8 is supported (1 byte per channel).</param>
|
|
<param name="width">Width of the image in pixels.</param>
|
|
<param name="height">Height of the image in pixels.</param>
|
|
<param name="rowstride">The rowstride is the number of bytes consumed by a single row in the image.</param>
|
|
<summary>Public constructor.</summary>
|
|
<remarks>The image must be in RGB format or RGBA format, where each channel takes one byte.</remarks>
|
|
<since version="Gtk# 2.10" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] data, Gdk.Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] data, valuetype Gdk.Colorspace colorspace, bool has_alpha, int32 bits_per_sample, int32 width, int32 height, int32 rowstride) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="colorspace" Type="Gdk.Colorspace" />
|
|
<Parameter Name="has_alpha" Type="System.Boolean" />
|
|
<Parameter Name="bits_per_sample" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="rowstride" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">The data that contains the image in RGB or RGBA format.</param>
|
|
<param name="colorspace">The <see cref="T:Gdk.Colorspace" /> for the image data.</param>
|
|
<param name="has_alpha">Whether the data contains an alpha channel (RGBA format).</param>
|
|
<param name="bits_per_sample">Currently only 8 is supported (1 byte per channel).</param>
|
|
<param name="width">Width of the image in pixels.</param>
|
|
<param name="height">Height of the image in pixels.</param>
|
|
<param name="rowstride">The rowstride is the number of bytes consumed by a single row in the image.</param>
|
|
<summary>Public constructor.</summary>
|
|
<remarks>The image must be in RGB format or RGBA format, where each channel takes one byte.</remarks>
|
|
<since version="Gtk# 2.10" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] data, bool has_alpha, int bits_per_sample, int width, int height, int rowstride, Gdk.PixbufDestroyNotify destroy_fn);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] data, bool has_alpha, int32 bits_per_sample, int32 width, int32 height, int32 rowstride, class Gdk.PixbufDestroyNotify destroy_fn) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="has_alpha" Type="System.Boolean" />
|
|
<Parameter Name="bits_per_sample" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="rowstride" Type="System.Int32" />
|
|
<Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">To be added.</param>
|
|
<param name="has_alpha">To be added.</param>
|
|
<param name="bits_per_sample">To be added.</param>
|
|
<param name="width">To be added.</param>
|
|
<param name="height">To be added.</param>
|
|
<param name="rowstride">To be added.</param>
|
|
<param name="destroy_fn">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte[] data, Gdk.Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height, int rowstride, Gdk.PixbufDestroyNotify destroy_fn);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] data, valuetype Gdk.Colorspace colorspace, bool has_alpha, int32 bits_per_sample, int32 width, int32 height, int32 rowstride, class Gdk.PixbufDestroyNotify destroy_fn) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="colorspace" Type="Gdk.Colorspace" />
|
|
<Parameter Name="has_alpha" Type="System.Boolean" />
|
|
<Parameter Name="bits_per_sample" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="rowstride" Type="System.Int32" />
|
|
<Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="data">The data that contains the image in RGB or RGBA format.</param>
|
|
<param name="colorspace">The <see cref="T:Gdk.Colorspace" /> for the image data.</param>
|
|
<param name="has_alpha">Whether the data contains an alpha channel (RGBA format).</param>
|
|
<param name="bits_per_sample">Currently only 8 is supported (1 byte per channel).</param>
|
|
<param name="width">Width of the image in pixels.</param>
|
|
<param name="height">Height of the image in pixels.</param>
|
|
<param name="rowstride">The rowstride is the number of bytes consumed by a single row in the image.</param>
|
|
<param name="destroy_fn">A routine to invoke when the reference count to this image reaches zero.</param>
|
|
<summary>Public constructor; creates a new <see cref="T:Gdk.Pixbuf" /> from an in-memory RGB or RGBA buffer.</summary>
|
|
<remarks>The image must be in RGB format or RGBA format, where each channel takes one byte.
|
|
|
|
<para>
|
|
For performance reasons sometimes images have some padding at the end of each row, this is done to ensure that access to the data is aligned. The <paramref name="row_stride" /> argument is the size in bytes of each row. If no padding is added the <paramref name="row_stride" /> is just: <paramref name="width" /> * (3 + <paramref name="has_alpha" />).
|
|
</para></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddAlpha">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf AddAlpha (bool substitute_color, byte r, byte g, byte b);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf AddAlpha(bool substitute_color, unsigned int8 r, unsigned int8 g, unsigned int8 b) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="substitute_color" Type="System.Boolean" />
|
|
<Parameter Name="r" Type="System.Byte" />
|
|
<Parameter Name="g" Type="System.Byte" />
|
|
<Parameter Name="b" Type="System.Byte" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="substitute_color"> Whether to set a color to zero
|
|
opacity. If this is <see langword="false" />, then the (r, g, b) arguments will be ignored.</param>
|
|
<param name="r">Red value to substitute</param>
|
|
<param name="g">Green value to substitute</param>
|
|
<param name="b">Blue value to substitute</param>
|
|
<summary>Adds an alpha channel to the Pixbuf</summary>
|
|
<returns>
|
|
<para>A new pixbuf with an alpha channel.</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
Takes an existing pixbuf and adds an alpha channel to
|
|
it. If the existing pixbuf already had an alpha channel,
|
|
the channel values are copied from the original;
|
|
otherwise, the alpha channel is initialized to 255 (full
|
|
opacity).
|
|
</para>
|
|
<para>
|
|
If <paramref name="substitute_color" /> is <see langword="true" />, then the color specified by (<paramref name="r" />, <paramref name="g" />, <paramref name="b" />)
|
|
will be assigned zero opacity. That is, if you pass (255,
|
|
255, 255) for the substitute color, all white pixels will
|
|
become fully transparent.
|
|
</para>
|
|
<para>
|
|
The original image is not modified, a copy of the image is
|
|
made and returned.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ApplyEmbeddedOrientation">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf ApplyEmbeddedOrientation ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf ApplyEmbeddedOrientation() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Applies an embedded orientation transform.</summary>
|
|
<returns>Returns a new pixbuf, or the existing one if no transform exists.</returns>
|
|
<remarks />
|
|
<since version="Gtk# 2.12" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="BitsPerSample">
|
|
<MemberSignature Language="C#" Value="public int BitsPerSample { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 BitsPerSample" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("bits-per-sample")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Number of bits per color sample in a pixbuf.</summary>
|
|
<value>The number of bits per color sample in the pixbuf</value>
|
|
<remarks>None.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Clone">
|
|
<MemberSignature Language="C#" Value="public object Clone ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance object Clone() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Colorspace">
|
|
<MemberSignature Language="C#" Value="public Gdk.Colorspace Colorspace { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gdk.Colorspace Colorspace" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("colorspace")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Colorspace</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The colorspace for this Pixbuf</summary>
|
|
<value>The colorspace used by this Pixbuf</value>
|
|
<remarks>
|
|
<para>
|
|
Currently Pixbuf only support the RGB colorspace.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Composite">
|
|
<MemberSignature Language="C#" Value="public void Composite (Gdk.Pixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, Gdk.InterpType interp_type, int overall_alpha);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Composite(class Gdk.Pixbuf dest, int32 dest_x, int32 dest_y, int32 dest_width, int32 dest_height, float64 offset_x, float64 offset_y, float64 scale_x, float64 scale_y, valuetype Gdk.InterpType interp_type, int32 overall_alpha) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="dest_width" Type="System.Int32" />
|
|
<Parameter Name="dest_height" Type="System.Int32" />
|
|
<Parameter Name="offset_x" Type="System.Double" />
|
|
<Parameter Name="offset_y" Type="System.Double" />
|
|
<Parameter Name="scale_x" Type="System.Double" />
|
|
<Parameter Name="scale_y" Type="System.Double" />
|
|
<Parameter Name="interp_type" Type="Gdk.InterpType" />
|
|
<Parameter Name="overall_alpha" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest">The destination Pixbuf to render to.</param>
|
|
<param name="dest_x">The left coordinate for region to render</param>
|
|
<param name="dest_y">The top coordinate for region to render</param>
|
|
<param name="dest_width">The width of the region to render</param>
|
|
<param name="dest_height">The height of the region to render</param>
|
|
<param name="offset_x">The offset in the X direction (currently rounded to an integer)</param>
|
|
<param name="offset_y">The offset in the Y direction (currently rounded to an integer)</param>
|
|
<param name="scale_x">The scale factor in the X direction</param>
|
|
<param name="scale_y">The scale factor in the Y direction</param>
|
|
<param name="interp_type">The interpolation type for the transformation.</param>
|
|
<param name="overall_alpha">Overall alpha for source image (0..255)</param>
|
|
<summary>Scale and Compose a Pixbuf</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a transformation of the Pixbuf by scaling by
|
|
<paramref name="scale_x" /> and <paramref name="scale_y" />
|
|
then translating by <paramref name="offset_x" /> and
|
|
<paramref name="offset_y" />, then composites the rectangle
|
|
(<paramref name="dest_x" />, <paramref name="dest_y" />,
|
|
<paramref name="dest_width" />, <paramref name="dest_height" />) of the resulting image onto the
|
|
destination image.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CompositeColor">
|
|
<MemberSignature Language="C#" Value="public void CompositeColor (Gdk.Pixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, Gdk.InterpType interp_type, int overall_alpha, int check_x, int check_y, int check_size, uint color1, uint color2);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CompositeColor(class Gdk.Pixbuf dest, int32 dest_x, int32 dest_y, int32 dest_width, int32 dest_height, float64 offset_x, float64 offset_y, float64 scale_x, float64 scale_y, valuetype Gdk.InterpType interp_type, int32 overall_alpha, int32 check_x, int32 check_y, int32 check_size, unsigned int32 color1, unsigned int32 color2) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="dest_width" Type="System.Int32" />
|
|
<Parameter Name="dest_height" Type="System.Int32" />
|
|
<Parameter Name="offset_x" Type="System.Double" />
|
|
<Parameter Name="offset_y" Type="System.Double" />
|
|
<Parameter Name="scale_x" Type="System.Double" />
|
|
<Parameter Name="scale_y" Type="System.Double" />
|
|
<Parameter Name="interp_type" Type="Gdk.InterpType" />
|
|
<Parameter Name="overall_alpha" Type="System.Int32" />
|
|
<Parameter Name="check_x" Type="System.Int32" />
|
|
<Parameter Name="check_y" Type="System.Int32" />
|
|
<Parameter Name="check_size" Type="System.Int32" />
|
|
<Parameter Name="color1" Type="System.UInt32" />
|
|
<Parameter Name="color2" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest">The destination Pixbuf to render to.</param>
|
|
<param name="dest_x">The left coordinate for region to render</param>
|
|
<param name="dest_y">The top coordinate for region to render</param>
|
|
<param name="dest_width">The width of the region to render</param>
|
|
<param name="dest_height">The height of the region to render</param>
|
|
<param name="offset_x">The offset in the X direction (currently rounded to an integer)</param>
|
|
<param name="offset_y">The offset in the Y direction (currently rounded to an integer)</param>
|
|
<param name="scale_x">The scale factor in the X direction</param>
|
|
<param name="scale_y">The scale factor in the Y direction</param>
|
|
<param name="interp_type">The interpolation type for the transformation.</param>
|
|
<param name="overall_alpha">Overall alpha for source image (0..255)</param>
|
|
<param name="check_x">The X offset for the checkboard (origin of checkboard is at -check_x, -check_y)</param>
|
|
<param name="check_y">The Y offset for the checkboard</param>
|
|
<param name="check_size">The size of checks in the checkboard (must be a power of two)</param>
|
|
<param name="color1">The color of check at upper left</param>
|
|
<param name="color2">The color of the other check</param>
|
|
<summary>Scale and Compose a Pixbuf with control over the checks</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a transformation of the Pixbuf by scaling by
|
|
<paramref name="scale_x" /> and <paramref name="scale_y" />
|
|
then translating by <paramref name="offset_x" /> and
|
|
<paramref name="offset_y" />, then composites the rectangle
|
|
(<paramref name="dest_x" /> ,<paramref name="dest_y" />,
|
|
<paramref name="dest_width" />, <paramref name="dest_height" />) of the resulting image with a
|
|
checkboard of the colors <paramref name="color1" /> and
|
|
<paramref name="color2" /> and renders it onto the
|
|
destination image.
|
|
</para>
|
|
<para>
|
|
The <paramref name="color1" /> and <paramref name="color2" /> encode the color in 32-bit RGB format.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CompositeColorSimple">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf CompositeColorSimple (int dest_width, int dest_height, Gdk.InterpType interp_type, int overall_alpha, int check_size, uint color1, uint color2);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf CompositeColorSimple(int32 dest_width, int32 dest_height, valuetype Gdk.InterpType interp_type, int32 overall_alpha, int32 check_size, unsigned int32 color1, unsigned int32 color2) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest_width" Type="System.Int32" />
|
|
<Parameter Name="dest_height" Type="System.Int32" />
|
|
<Parameter Name="interp_type" Type="Gdk.InterpType" />
|
|
<Parameter Name="overall_alpha" Type="System.Int32" />
|
|
<Parameter Name="check_size" Type="System.Int32" />
|
|
<Parameter Name="color1" Type="System.UInt32" />
|
|
<Parameter Name="color2" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest_width">The width of destination image</param>
|
|
<param name="dest_height">The height of destination image</param>
|
|
<param name="interp_type">The interpolation type for the transformation.</param>
|
|
<param name="overall_alpha">Overall alpha for source image (0..255)</param>
|
|
<param name="check_size">The size of checks in the checkboard (must be a power of two)</param>
|
|
<param name="color1">The color of check at upper left</param>
|
|
<param name="color2">The color of the other check</param>
|
|
<summary>Scaling with checkboard rendering</summary>
|
|
<returns>
|
|
<para>
|
|
The new Pixbuf, or <see langword="null" /> if not enough
|
|
memory could be allocated for it.
|
|
</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
Creates a new Pixbuf by scaling <paramref name="src" /> to
|
|
<paramref name="dest_width" /> x
|
|
<paramref name="dest_height" /> and compositing the result with a checkboard
|
|
of colors <paramref name="color1" /> and <paramref name="color2" />.
|
|
</para>
|
|
<para>
|
|
The colors must be in RGB format.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Copy">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Copy ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf Copy() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Copies the Pixbuf</summary>
|
|
<returns>
|
|
<para>
|
|
A copy of the data in the Pixbuf, or <see langword="null" /> on failure
|
|
</para>
|
|
</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CopyArea">
|
|
<MemberSignature Language="C#" Value="public void CopyArea (int src_x, int src_y, int width, int height, Gdk.Pixbuf dest_pixbuf, int dest_x, int dest_y);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyArea(int32 src_x, int32 src_y, int32 width, int32 height, class Gdk.Pixbuf dest_pixbuf, int32 dest_x, int32 dest_y) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="dest_pixbuf" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="src_x">Source X coordinate within src_pixbuf.</param>
|
|
<param name="src_y">Source Y coordinate within src_pixbuf</param>
|
|
<param name="width">Width of the area to copy.</param>
|
|
<param name="height">Height of the area to copy.</param>
|
|
<param name="dest_pixbuf">Destination Pixbuf.</param>
|
|
<param name="dest_x">X coordinate within dest_pixbuf.</param>
|
|
<param name="dest_y">Y coordinate within dest_pixbuf.</param>
|
|
<summary>Copies a region from one Pixbuf to another</summary>
|
|
<remarks>
|
|
<para>
|
|
Copies a rectangular area from src_pixbuf to
|
|
dest_pixbuf. Conversion of pixbuf formats is done
|
|
automatically.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Equal">
|
|
<MemberSignature Language="C#" Value="public bool Equal (GLib.IIcon icon2);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equal(class GLib.IIcon icon2) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="icon2" Type="GLib.IIcon" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="icon2">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ErrorQuark">
|
|
<MemberSignature Language="C#" Value="public static int ErrorQuark ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 ErrorQuark() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:System.Int32" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Fill">
|
|
<MemberSignature Language="C#" Value="public void Fill (uint pixel);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Fill(unsigned int32 pixel) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixel" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="pixel">RGBA value for the pixel to set (0xffffffff is opaque white, 0x00000000 transparent black)</param>
|
|
<summary>
|
|
Fills a pixbuf with a single color
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Clears a pixbuf to the given RGBA value, converting the
|
|
RGBA value into the pixbuf's pixel format. The alpha will
|
|
be ignored if the Pixbuf does not have an alpha channel.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Flip">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Flip (bool horizontal);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf Flip(bool horizontal) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="horizontal" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="horizontal">
|
|
<see langword="true" /> to flip horizontally, <see langword="false" /> to flip vertically.</param>
|
|
<summary>Flips a pixbuf horizontally or vertically.</summary>
|
|
<returns>A <see cref="T:Gdk.Pixbuf" />.</returns>
|
|
<remarks />
|
|
<since version="Gtk# 2.6" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Formats">
|
|
<MemberSignature Language="C#" Value="public static Gdk.PixbufFormat[] Formats { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property class Gdk.PixbufFormat[] Formats" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.PixbufFormat[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>a <see cref="T:Gdk.PixbufFormat[]" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromPixdata">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromPixdata (Gdk.Pixdata pixdata, bool copy_pixels);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Pixbuf FromPixdata(valuetype Gdk.Pixdata pixdata, bool copy_pixels) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixdata" Type="Gdk.Pixdata" />
|
|
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="pixdata">Source Gdk.Pixdata</param>
|
|
<param name="copy_pixels">Whether to make a private copy of the data</param>
|
|
<summary>
|
|
Creates a Pixbuf from a Pixdata
|
|
</summary>
|
|
<returns>
|
|
<para>
|
|
The return value is an initialized Pixbuf class
|
|
</para>
|
|
</returns>
|
|
<remarks>
|
|
This creates a Pixbuf from a class that implements the
|
|
Gdk.Pixdata interface.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetFileInfo">
|
|
<MemberSignature Language="C#" Value="public static Gdk.PixbufFormat GetFileInfo (string filename, out int width, out int height);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.PixbufFormat GetFileInfo(string filename, int32 width, int32 height) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.PixbufFormat</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="width" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="height" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">a <see cref="T:System.String" /></param>
|
|
<param name="width">a <see cref="T:System.Int32" /></param>
|
|
<param name="height">a <see cref="T:System.Int32" /></param>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:Gdk.PixbufFormat" /></returns>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetOption">
|
|
<MemberSignature Language="C#" Value="public string GetOption (string key);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetOption(string key) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="key">the key to lookup</param>
|
|
<summary>Looks up an option in the Pixbuf</summary>
|
|
<returns>The value associated with the <paramref name="key" /></returns>
|
|
<remarks>
|
|
<para>
|
|
Looks up key in the list of options that may have been
|
|
attached to the pixbuf when it was loaded.
|
|
</para>
|
|
</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.Pixbuf" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="HasAlpha">
|
|
<MemberSignature Language="C#" Value="public bool HasAlpha { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool HasAlpha" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("has-alpha")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Returns whether the Pixbuf contains an alpha channel</summary>
|
|
<value>
|
|
<see langword="true" /> if the image contains an Alpha
|
|
channel, <see langword="false" /> otherwise.</value>
|
|
<remarks>
|
|
<para>
|
|
The Pixbuf object handles images in either the RGB format,
|
|
or the RGBA format. The alpha channel value is a value
|
|
between 0 and 255 and controls the opacity of a given pixel.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Height">
|
|
<MemberSignature Language="C#" Value="public int Height { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Height" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("height")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Height of the image</summary>
|
|
<value>
|
|
<para>The height in pixels of the image</para>
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
See also the <see cref="P:Gdk.Pixbuf.Width" />, <see cref="P:Gdk.Pixbuf.Rowstride" /> and <see cref="P:Gdk.Pixbuf.NChannels" /> for more information about
|
|
the layout of the image.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LoadFromResource">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf LoadFromResource (string resource);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Pixbuf LoadFromResource(string resource) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="resource">the name of the resource</param>
|
|
<summary>Loads a pixbuf from a resource file.</summary>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>
|
|
This loads a pixbuf from a resource in the calling assembly. This is equivalent to
|
|
using the <see cref="C:Gdk.Pixbuf(System.Reflection.Assembly, System.String)" />
|
|
constructor with a <see langword="null" /> assembly.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="NChannels">
|
|
<MemberSignature Language="C#" Value="public int NChannels { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 NChannels" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("n-channels")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The number of channels on a Pixbuf</summary>
|
|
<value>Returns the number of channels on a Pixbuf</value>
|
|
<remarks>
|
|
The possible values are 3 (for RGB encoding) and 4 (for RGB
|
|
with an alpha transparency channel encoding).
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Pixels">
|
|
<MemberSignature Language="C#" Value="public IntPtr Pixels { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance native int Pixels" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The pixels contained by this Pixbuf object.</summary>
|
|
<value>a <see cref="T:System.IntPtr" />, pointer to the underlying C data</value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ref">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Ref ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf Ref() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RotateSimple">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf RotateSimple (Gdk.PixbufRotation angle);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf RotateSimple(valuetype Gdk.PixbufRotation angle) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="angle" Type="Gdk.PixbufRotation" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="angle">The angle to rotate by.</param>
|
|
<summary>Rotates a pixbuf by a multiple of 90 degrees, and returns the result in a new pixbuf.</summary>
|
|
<returns>A <see cref="T:Gdk.Pixbuf" />.</returns>
|
|
<remarks />
|
|
<since version="Gtk# 2.6" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Rowstride">
|
|
<MemberSignature Language="C#" Value="public int Rowstride { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Rowstride" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("rowstride")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Rowstride of the Pixbuf</summary>
|
|
<value>The rowstride property for the Pixbuf</value>
|
|
<remarks>
|
|
<para>
|
|
Queries the rowstride of a pixbuf. The rowstring is the
|
|
number of bytes occupied by a row of pixels. Sometimes
|
|
for alignment purposes, the rowstride might be bigger than
|
|
the actual width of the image. Applications that
|
|
manually process data from the image would scan lines by
|
|
adding the value of the Rowstride.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaturateAndPixelate">
|
|
<MemberSignature Language="C#" Value="public void SaturateAndPixelate (Gdk.Pixbuf dest, float saturation, bool pixelate);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SaturateAndPixelate(class Gdk.Pixbuf dest, float32 saturation, bool pixelate) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="saturation" Type="System.Single" />
|
|
<Parameter Name="pixelate" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest">Target Pixbuf where the resulting image is stored</param>
|
|
<param name="saturation">saturation factor</param>
|
|
<param name="pixelate">whether to pixelation will take place</param>
|
|
<summary>Saturation and pixelation of a Pixbuf</summary>
|
|
<remarks>
|
|
<para>
|
|
Modifies saturation and optionally pixelates the Pixbuf,
|
|
placing the result in <paramref name="dest" />. <paramref name="dest" /> may be the same Pixbuf with no ill
|
|
effects. If <paramref name="saturation" /> is 1.0 then
|
|
saturation is not changed. If it's less than 1.0,
|
|
saturation is reduced (the image is darkened); if greater
|
|
than 1.0, saturation is increased (the image is
|
|
brightened). If <paramref name="pixelate" /> is <see langword="true" />, then pixels are faded in a checkerboard
|
|
pattern to create a pixelated image. src and dest must
|
|
have the same image format, size, and rowstride.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Save">
|
|
<MemberSignature Language="C#" Value="public bool Save (string filename, string type);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Save(string filename, string type) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="type" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">a <see cref="T:System.String" />, name of the file to save</param>
|
|
<param name="type">a <see cref="T:System.String" />, file format to save in ("jpeg" and "png" are supported).</param>
|
|
<summary>Saves pixbuf to a file.</summary>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>The Gtk+ version of this call supports a text string of
|
|
arguments, which Gtk# currently does not include. (TODO: explain
|
|
the difference between Save and Savev, in light of this API
|
|
difference.)
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaveToBuffer">
|
|
<MemberSignature Language="C#" Value="public byte[] SaveToBuffer (string type);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] SaveToBuffer(string type) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Byte[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="type" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="type">an image type, such as png, jpeg, or ico</param>
|
|
<summary>Saves to a buffer.</summary>
|
|
<returns>a <see cref="T:System.Byte[]" /></returns>
|
|
<remarks>Throws a <see cref="T:GLib.GException" /> if the save is not successful.</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaveToBuffer">
|
|
<MemberSignature Language="C#" Value="public byte[] SaveToBuffer (string type, string[] option_keys, string[] option_values);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] SaveToBuffer(string type, string[] option_keys, string[] option_values) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Byte[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="type" Type="System.String" />
|
|
<Parameter Name="option_keys" Type="System.String[]" />
|
|
<Parameter Name="option_values" Type="System.String[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="type">an image type, such as png, jpeg, or ico</param>
|
|
<param name="option_keys">an array of option keys.</param>
|
|
<param name="option_values">an array of option values.</param>
|
|
<summary>Saves to a buffer.</summary>
|
|
<returns>a <see cref="T:System.Byte[]" /></returns>
|
|
<remarks>>The <paramref name="option_keys" /> and <paramref name="option_values" /> should contain key/value pairs. See <see cref="M:Gdk.Pixbuf.Save" /> for more details. Throws a <see cref="T:GLib.GException" /> if the save is not successful.</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaveToCallback">
|
|
<MemberSignature Language="C#" Value="public void SaveToCallback (Gdk.PixbufSaveFunc save_func, string type);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SaveToCallback(class Gdk.PixbufSaveFunc save_func, string type) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="save_func" Type="Gdk.PixbufSaveFunc" />
|
|
<Parameter Name="type" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="save_func">a <see cref="T:Gdk.PixbufSaveFunc" /></param>
|
|
<param name="type">an image type, such as png, jpeg, or ico</param>
|
|
<summary>Save using a callback delegate.</summary>
|
|
<remarks>Throws a <see cref="T:GLib.GException" /> if the save is not successful.</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaveToCallback">
|
|
<MemberSignature Language="C#" Value="public void SaveToCallback (Gdk.PixbufSaveFunc save_func, string type, string[] option_keys, string[] option_values);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SaveToCallback(class Gdk.PixbufSaveFunc save_func, string type, string[] option_keys, string[] option_values) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="save_func" Type="Gdk.PixbufSaveFunc" />
|
|
<Parameter Name="type" Type="System.String" />
|
|
<Parameter Name="option_keys" Type="System.String[]" />
|
|
<Parameter Name="option_values" Type="System.String[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="save_func">a <see cref="T:Gdk.PixbufSaveFunc" /></param>
|
|
<param name="type">an image type, such as png, jpeg, or ico</param>
|
|
<param name="option_keys">an array of option keys</param>
|
|
<param name="option_values">an array of option values</param>
|
|
<summary>Save using a callback delegate.</summary>
|
|
<remarks>The <paramref name="option_keys" /> and <paramref name="option_values" /> should contain key/value pairs. See <see cref="M:Gdk.Pixbuf.Save" /> for more details. Throws a <see cref="T:GLib.GException" /> if the save is not successful.</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Savev">
|
|
<MemberSignature Language="C#" Value="public bool Savev (string filename, string type, string[] option_keys, string[] option_values);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Savev(string filename, string type, string[] option_keys, string[] option_values) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="type" Type="System.String" />
|
|
<Parameter Name="option_keys" Type="System.String[]" />
|
|
<Parameter Name="option_values" Type="System.String[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">Name of the file where the image will be saved</param>
|
|
<param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param>
|
|
<param name="option_keys">Options that are passed to the save module.</param>
|
|
<param name="option_values">Values for each key</param>
|
|
<summary>Saves pixbuf to a file.</summary>
|
|
<returns>A <see cref="T:System.Boolean" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Scale">
|
|
<MemberSignature Language="C#" Value="public void Scale (Gdk.Pixbuf dest, int dest_x, int dest_y, int dest_width, int dest_height, double offset_x, double offset_y, double scale_x, double scale_y, Gdk.InterpType interp_type);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Scale(class Gdk.Pixbuf dest, int32 dest_x, int32 dest_y, int32 dest_width, int32 dest_height, float64 offset_x, float64 offset_y, float64 scale_x, float64 scale_y, valuetype Gdk.InterpType interp_type) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest" Type="Gdk.Pixbuf" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="dest_width" Type="System.Int32" />
|
|
<Parameter Name="dest_height" Type="System.Int32" />
|
|
<Parameter Name="offset_x" Type="System.Double" />
|
|
<Parameter Name="offset_y" Type="System.Double" />
|
|
<Parameter Name="scale_x" Type="System.Double" />
|
|
<Parameter Name="scale_y" Type="System.Double" />
|
|
<Parameter Name="interp_type" Type="Gdk.InterpType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest">The destination Pixbuf where the results
|
|
are rendered</param>
|
|
<param name="dest_x">The left coordinate for region to render</param>
|
|
<param name="dest_y">The top coordinate for region to render</param>
|
|
<param name="dest_width">The width of the region to render</param>
|
|
<param name="dest_height">The height of the region to render</param>
|
|
<param name="offset_x">The offset in the X direction (currently rounded to an integer)</param>
|
|
<param name="offset_y">The offset in the Y direction (currently rounded to an integer)</param>
|
|
<param name="scale_x">The scale factor in the X direction</param>
|
|
<param name="scale_y">The scale factor in the Y direction</param>
|
|
<param name="interp_type">The interpolation type for the transformation.</param>
|
|
<summary>Scale transformation.</summary>
|
|
<remarks>
|
|
<para>
|
|
Creates a transformation of the Pixbuf by scaling to
|
|
<paramref name="scale_x" /> and <paramref name="scale_y" />
|
|
then translating by <paramref name="offset_x" /> and
|
|
<paramref name="offset_y" />, then renders the rectangle
|
|
(<paramref name="dest_x" />, <paramref name="dest_y" />,
|
|
<paramref name="dest_width" />, <paramref name="dest_height" />) of the resulting image onto the
|
|
destination image replacing the previous contents.
|
|
</para>
|
|
<para>
|
|
Try to use <see cref="M:Gdk.Pixbuf.ScaleSimple" />, this
|
|
function is the industrial-strength power tool you can
|
|
fall back to if <see cref="M:Gdk.Pixbuf.ScaleSimple" /> is
|
|
not powerful enough.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ScaleSimple">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf ScaleSimple (int dest_width, int dest_height, Gdk.InterpType interp_type);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gdk.Pixbuf ScaleSimple(int32 dest_width, int32 dest_height, valuetype Gdk.InterpType interp_type) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dest_width" Type="System.Int32" />
|
|
<Parameter Name="dest_height" Type="System.Int32" />
|
|
<Parameter Name="interp_type" Type="Gdk.InterpType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="dest_width">The width of destination image</param>
|
|
<param name="dest_height">The height of destination image</param>
|
|
<param name="interp_type">The interpolation type for the transformation</param>
|
|
<summary>Scales a Pixbuf</summary>
|
|
<returns>
|
|
<para>
|
|
A new Pixbuf object, or <see langword="null" /> if no
|
|
memory is available for the transformation.
|
|
</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
Create a new GdkPixbuf containing a copy of src scaled to
|
|
<paramref name="dest_width" /> x <paramref name="dest_height" />. It leaves the current Pixbuf
|
|
unaffected. <paramref name="interp_type" /> should be <see cref="F:Gdk.InterpType.Nearest" /> if you want maximum
|
|
speed (but when scaling down <see cref="F:Gdk.InterpType.Nearest" /> is usually unusably
|
|
ugly). The default <paramref name="interp_type" /> should
|
|
be <see cref="F:Gdk.InterpType.Bilinear" /> which offers
|
|
reasonable quality and speed.
|
|
</para>
|
|
<para>
|
|
You can scale a sub-portion of the Pixbuf by creating a
|
|
sub-pixbuf using a Pixbuf constructor.
|
|
</para>
|
|
<para>
|
|
For more complicated scale/compositions see <see cref="M:Gdk.Pixbuf.Scale" /> and <see cref="M:Gdk.Pixbuf.Composite" /></para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToString">
|
|
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Unref">
|
|
<MemberSignature Language="C#" Value="public void Unref ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Unref() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Width">
|
|
<MemberSignature Language="C#" Value="public int Width { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Width" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("width")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The width of the image</summary>
|
|
<value>
|
|
<para>The width in pixels of the image</para>
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
This is the width of the image in pixels. See the <see cref="P:Gdk.Pixbuf.Rowstride" /> property as well.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|