mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-25 06:25:33 +00:00
1386 lines
64 KiB
XML
1386 lines
64 KiB
XML
<Type Name="Pixbuf" FullName="Gdk.Pixbuf">
|
|
<TypeSignature Language="C#" Value="public class Pixbuf : GLib.Object, IWrapper, IDisposable" Maintainer="miguel" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gdk-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>In memory image handling and representation.</summary>
|
|
<remarks>
|
|
<para>
|
|
The Gdk.Pixbuf class is used to represent an image in
|
|
memory. 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>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="FromPixdata">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf FromPixdata (Gdk.Pixdata pixdata, bool copy_pixels);" />
|
|
<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>
|
|
<summary>
|
|
Creates a Pixbuf from a Pixdata
|
|
</summary>
|
|
<param name="pixdata">Source Gdk.Pixdata</param>
|
|
<param name="copy_pixels">Whether to make a private copy of the data</param>
|
|
<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="AddAlpha">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf AddAlpha (bool substitute_color, byte r, byte g, byte b);" />
|
|
<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>
|
|
<summary>Adds an alpha channel to the Pixbuf</summary>
|
|
<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>
|
|
<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="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);" />
|
|
<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>
|
|
<summary>Scaling with checkboard rendering</summary>
|
|
<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>
|
|
<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="ScaleSimple">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf ScaleSimple (int dest_width, int dest_height, Gdk.InterpType interp_type);" />
|
|
<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>
|
|
<summary>Scales a Pixbuf</summary>
|
|
<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>
|
|
<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="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);" />
|
|
<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>
|
|
<summary>Scale and Compose a Pixbuf with control over the checks</summary>
|
|
<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>
|
|
<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="GetFromImage">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf GetFromImage (Gdk.Image src, Gdk.Colormap cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="src" Type="Gdk.Image" />
|
|
<Parameter Name="cmap" Type="Gdk.Colormap" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets an image from a Gdk.Image</summary>
|
|
<param name="image">Source Image (A <see cref="T:Gdk.Image" />)</param>
|
|
<param name="cmap">A colormap (if src does not have one set) (A <see cref="T:Gdk.Colormap" /></param>
|
|
<param name="src_x">Source X coordinate within drawable.</param>
|
|
<param name="src_y">Source Y coordinate within drawable.</param>
|
|
<param name="dest_x">Destination X coordinate in pixbuf, or 0
|
|
if dest is <see langword="null" />.</param>
|
|
<param name="dest_y">Destination Y coordinate in pixbuf, or 0
|
|
if dest is <see langword="null" />.</param>
|
|
<param name="width">Width in pixels of region to get.</param>
|
|
<param name="height">Height in pixels of region to get.</param>
|
|
<returns>
|
|
<para>
|
|
The value of the Pixbuf (the same one that was passed) or
|
|
<see langword="null" /> on error. See the remarks below
|
|
for details on the possible ways on which this function
|
|
might fail.
|
|
</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
Transfers image data from a <see cref="T:Gdk.Image" /> and
|
|
converts it to an RGB(A) representation inside a <see cref="T:Gdk.Pixbuf" />. In other words, copies image data
|
|
from the Image (which might be potentially shared using
|
|
shared memory between the client and the server) to a
|
|
client-side RGB(A) buffer (the Pixbuf). This allows you to
|
|
efficiently read individual pixels on the client side.
|
|
</para>
|
|
<para>
|
|
If the <paramref name="image" /> has no colormap (<see cref="P:Gdk.Image.Colormap" /> returns <see langword="null" />), then a suitable colormap must be
|
|
specified. Typically a <see cref="T:Gdk.Window" /> or a
|
|
pixmap created by passing a <see cref="T:Gdk.Window" /> to
|
|
the <see cref="T:Gdk.Pixmap" /> constructor will already
|
|
have a colormap associated with it. If the <paramref name="image" /> has a colormap, the <paramref name="cmap" /> argument will be ignored. If the <paramref name="image" /> is a bitmap (1 bit per pixel pixmap),
|
|
then a colormap is not required; pixels with a value of 1
|
|
are assumed to be white, and pixels with a value of 0 are
|
|
assumed to be black. For taking screenshots, the <see cref="P:Gdk.Colormap.System" /> property returns the
|
|
correct colormap to use.
|
|
</para>
|
|
<para>
|
|
If the specified destination pixbuf <paramref name="dest" /> is <see langword="null" />, then this
|
|
function will create an RGB Pixbuf with 8 bits per channel
|
|
and no alpha, with the same size specified by the width
|
|
and height arguments. In this case, the <paramref name="dest_x" /> and <paramref name="dest_y" /> arguments
|
|
must be specified as 0. If the specified destination
|
|
pixbuf is not <see langword="null" /> and it contains alpha
|
|
information, then the filled pixels will be set to full
|
|
opacity (alpha = 255).
|
|
</para>
|
|
<para>
|
|
If the specified <paramref name="image" /> is a pixmap,
|
|
then the requested source rectangle must be completely
|
|
contained within the pixmap, otherwise the function will
|
|
return <see langword="null" />. For pixmaps only (not for
|
|
windows) passing -1 for <paramref name="width" /> or
|
|
<paramref name="height" /> is allowed, to mean the full
|
|
width or height of the pixmap.
|
|
</para>
|
|
<para>
|
|
If the specified <paramref name="image" /> is a window,
|
|
and the window is off the screen, then there is no image
|
|
data in the obscured/offscreen regions to be placed in the
|
|
pixbuf. The contents of portions of the <see cref="T:Gdk.Pixbuf" /> corresponding to the offscreen
|
|
region are undefined.
|
|
</para>
|
|
<para>
|
|
If the window you are obtaining data from is partially
|
|
obscured by other windows, then the contents of the Pixbuf
|
|
areas corresponding to the obscured regions are undefined.
|
|
</para>
|
|
<para>
|
|
If the target image is not mapped (typically because
|
|
it's iconified/minimized or not on the current workspace),
|
|
then <see langword="null" /> will be returned.
|
|
</para>
|
|
<para>
|
|
If memory can't be allocated for the return value, <see langword="null" /> will be returned instead.
|
|
</para>
|
|
<para>
|
|
(In short, there are several ways this function can fail,
|
|
and if it fails it returns <see langword="null" />; so
|
|
check the return value.)
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RenderToDrawable">
|
|
<MemberSignature Language="C#" Value="public void RenderToDrawable (Gdk.Drawable drawable, Gdk.GC gc, int src_x, int src_y, int dest_x, int dest_y, int width, int height, Gdk.RgbDither dither, int x_dither, int y_dither);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="drawable" Type="Gdk.Drawable" />
|
|
<Parameter Name="gc" Type="Gdk.GC" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="dither" Type="Gdk.RgbDither" />
|
|
<Parameter Name="x_dither" Type="System.Int32" />
|
|
<Parameter Name="y_dither" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Renders the image into a Drawable</summary>
|
|
<param name="drawable">Destination drawable.</param>
|
|
<param name="gc">GC used for rendering.</param>
|
|
<param name="src_x">Source X coordinate within pixbuf.</param>
|
|
<param name="src_y">Source Y coordinate within pixbuf.</param>
|
|
<param name="dest_x">Destination X coordinate within drawable.</param>
|
|
<param name="dest_y">Destination Y coordinate within drawable.</param>
|
|
<param name="width">Width of region to render, in pixels, or -1 to use pixbuf width</param>
|
|
<param name="height">Height of region to render, in pixels, or -1 to use pixbuf height</param>
|
|
<param name="dither">Dithering mode for GdkRGB.</param>
|
|
<param name="x_dither">X offset for dither.</param>
|
|
<param name="y_dither"> Y offset for dither.</param>
|
|
<remarks>
|
|
<para>
|
|
Renders a rectangular portion of the Pixbuf into the
|
|
<paramref name="drawable" /> while using the specified
|
|
<paramref name="gc" />. This is done using GdkRGB, so the
|
|
specified drawable must have the <see cref="T:Gdk.RGB" />
|
|
visual and colormap. Note that this function will ignore
|
|
the opacity information for images with an alpha channel;
|
|
the GC must already have the clipping mask set if you want
|
|
transparent regions to show through.
|
|
</para>
|
|
<para>
|
|
For an explanation of dither offsets, see the GdkRGB
|
|
documentation. In brief, the dither offset is important
|
|
when re-rendering partial regions of an image to a
|
|
rendered version of the full image, or for when the
|
|
offsets to a base position change, as in scrolling. The
|
|
dither matrix has to be shifted for consistent visual
|
|
results. If you do not have any of these cases, the dither
|
|
offsets can be both zero.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetFromDrawable">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf GetFromDrawable (Gdk.Drawable src, Gdk.Colormap cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="drawable" Type="Gdk.Drawable" />
|
|
<Parameter Name="cmap" Type="Gdk.Colormap" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets image from a Gdk.Drawable</summary>
|
|
<param name="drawable">Source drawable (A <see cref="T:Gdk.Drawable" />)</param>
|
|
<param name="cmap">A colormap (if src does not have one set) (A <see cref="T:Gdk.Colormap" /></param>
|
|
<param name="src_x">Source X coordinate within drawable.</param>
|
|
<param name="src_y">Source Y coordinate within drawable.</param>
|
|
<param name="dest_x">Destination X coordinate in pixbuf, or 0
|
|
if dest is <see langword="null" />.</param>
|
|
<param name="dest_y">Destination Y coordinate in pixbuf, or 0
|
|
if dest is <see langword="null" />.</param>
|
|
<param name="width">Width in pixels of region to get.</param>
|
|
<param name="height">Height in pixels of region to get.</param>
|
|
<returns>
|
|
<para>
|
|
The value of the Pixbuf (the same one that was passed) or
|
|
<see langword="null" /> on error. See the remarks below
|
|
for details on the possible ways on which this function
|
|
might fail.
|
|
</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
Transfers image data from a <see cref="T:Gdk.Drawable" />
|
|
and converts it to an RGB(A) representation inside a <see cref="T:Gdk.Pixbuf" />. In other words, copies image data
|
|
from a server-side drawable to a client-side RGB(A)
|
|
buffer. This allows you to efficiently read individual
|
|
pixels on the client side.
|
|
</para>
|
|
<para>
|
|
If the <paramref name="drawable" /> has no colormap (<see cref="P:Gdk.Drawable.Colormap" /> returns <see langword="null" />), then a suitable colormap must be
|
|
specified. Typically a <see cref="T:Gdk.Window" /> or a
|
|
pixmap created by passing a <see cref="T:Gdk.Window" /> to
|
|
the <see cref="T:Gdk.Pixmap" /> constructor will already
|
|
have a colormap associated with it. If the <paramref name="drawable" /> has a colormap, the <paramref name="cmap" /> argument will be ignored. If the <paramref name="drawable" /> is a bitmap (1 bit per pixel pixmap),
|
|
then a colormap is not required; pixels with a value of 1
|
|
are assumed to be white, and pixels with a value of 0 are
|
|
assumed to be black. For taking screenshots, the <see cref="P:Gdk.Colormap.System" /> property returns the
|
|
correct colormap to use.
|
|
</para>
|
|
<para>
|
|
If the specified destination pixbuf <paramref name="dest" /> is <see langword="null" />, then this
|
|
function will create an RGB Pixbuf with 8 bits per channel
|
|
and no alpha, with the same size specified by the width
|
|
and height arguments. In this case, the <paramref name="dest_x" /> and <paramref name="dest_y" /> arguments
|
|
must be specified as 0. If the specified destination
|
|
pixbuf is not <see langword="null" /> and it contains alpha
|
|
information, then the filled pixels will be set to full
|
|
opacity (alpha = 255).
|
|
</para>
|
|
<para>
|
|
If the specified <paramref name="drawable" /> is a pixmap,
|
|
then the requested source rectangle must be completely
|
|
contained within the pixmap, otherwise the function will
|
|
return <see langword="null" />. For pixmaps only (not for
|
|
windows) passing -1 for <paramref name="width" /> or
|
|
<paramref name="height" /> is allowed, to mean the full
|
|
width or height of the pixmap.
|
|
</para>
|
|
<para>
|
|
If the specified <paramref name="drawable" /> is a window,
|
|
and the window is off the screen, then there is no image
|
|
data in the obscured/offscreen regions to be placed in the
|
|
pixbuf. The contents of portions of the <see cref="T:Gdk.Pixbuf" /> corresponding to the offscreen
|
|
region are undefined.
|
|
</para>
|
|
<para>
|
|
If the window you are obtaining data from is partially
|
|
obscured by other windows, then the contents of the Pixbuf
|
|
areas corresponding to the obscured regions are undefined.
|
|
</para>
|
|
<para>
|
|
If the target drawable is not mapped (typically because
|
|
it's iconified/minimized or not on the current workspace),
|
|
then <see langword="null" /> will be returned.
|
|
</para>
|
|
<para>
|
|
If memory can't be allocated for the return value, <see langword="null" /> will be returned instead.
|
|
</para>
|
|
<para>
|
|
(In short, there are several ways this function can fail,
|
|
and if it fails it returns <see langword="null" />; so
|
|
check the return value.)
|
|
</para>
|
|
<para>
|
|
This function calls <see cref="M:Gdk.Drawable.GetImage(int,int,int,int)" />
|
|
internally and converts the resulting image to a <see cref="T:Gdk.Pixbuf" />, so the documentation for <see cref="M:Gdk.Drawable.GetImage(int,int,int,int)" /> is also
|
|
relevant.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Copy">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Copy ();" />
|
|
<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="Clone">
|
|
<MemberSignature Language="C#" Value="public object Clone ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Clones the Pixbuf</summary>
|
|
<returns>
|
|
<para>
|
|
Implements the <see cref="M:ICloneable.IClone()" /> method.
|
|
</para>
|
|
</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RenderPixmapAndMaskForColormap">
|
|
<MemberSignature Language="C#" Value="public void RenderPixmapAndMaskForColormap (Gdk.Colormap colormap, Gdk.Pixmap pixmap_return, Gdk.Bitmap mask_return, int alpha_threshold);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="colormap" Type="Gdk.Colormap" />
|
|
<Parameter Name="pixmap_return" Type="Gdk.Pixmap" />
|
|
<Parameter Name="mask_return" Type="Gdk.Bitmap" />
|
|
<Parameter Name="alpha_threshold" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="colormap">To be added: an object of type 'Gdk.Colormap'</param>
|
|
<param name="pixmap_return">To be added: an object of type 'Gdk.Pixmap'</param>
|
|
<param name="mask_return">To be added: an object of type 'Gdk.Bitmap'</param>
|
|
<param name="alpha_threshold">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RenderThresholdAlpha">
|
|
<MemberSignature Language="C#" Value="public void RenderThresholdAlpha (Gdk.Bitmap bitmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height, int alpha_threshold);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="bitmap" Type="Gdk.Bitmap" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="alpha_threshold" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="bitmap">To be added: an object of type 'Gdk.Bitmap'</param>
|
|
<param name="src_x">To be added: an object of type 'int'</param>
|
|
<param name="src_y">To be added: an object of type 'int'</param>
|
|
<param name="dest_x">To be added: an object of type 'int'</param>
|
|
<param name="dest_y">To be added: an object of type 'int'</param>
|
|
<param name="width">To be added: an object of type 'int'</param>
|
|
<param name="height">To be added: an object of type 'int'</param>
|
|
<param name="alpha_threshold">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</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);" />
|
|
<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>
|
|
<summary>Scale and Compose a Pixbuf</summary>
|
|
<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>
|
|
<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="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);" />
|
|
<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>
|
|
<summary>Scale transformation.</summary>
|
|
<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>
|
|
<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="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);" />
|
|
<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>
|
|
<summary>Copies a region from one Pixbuf to another</summary>
|
|
<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>
|
|
<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="Fill">
|
|
<MemberSignature Language="C#" Value="public void Fill (uint pixel);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixel" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>
|
|
Fills a pixbuf with a single color
|
|
</summary>
|
|
<param name="pixel">RGBA value for the pixel to set (0xffffffff is opaque white, 0x00000000 transparent black)</param>
|
|
<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="GetOption">
|
|
<MemberSignature Language="C#" Value="public string GetOption (string key);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Looks up an option in the Pixbuf</summary>
|
|
<param name="key">the key to lookup</param>
|
|
<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="RenderPixmapAndMask">
|
|
<MemberSignature Language="C#" Value="public void RenderPixmapAndMask (Gdk.Pixmap pixmap_return, Gdk.Bitmap mask_return, int alpha_threshold);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixmap_return" Type="Gdk.Pixmap" />
|
|
<Parameter Name="mask_return" Type="Gdk.Bitmap" />
|
|
<Parameter Name="alpha_threshold" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="pixmap_return">To be added: an object of type 'Gdk.Pixmap'</param>
|
|
<param name="mask_return">To be added: an object of type 'Gdk.Bitmap'</param>
|
|
<param name="alpha_threshold">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaturateAndPixelate">
|
|
<MemberSignature Language="C#" Value="public void SaturateAndPixelate (Gdk.Pixbuf dest, float saturation, bool pixelate);" />
|
|
<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>
|
|
<summary>Saturation and pixelation of a Pixbuf</summary>
|
|
<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>
|
|
<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="RenderToDrawableAlpha">
|
|
<MemberSignature Language="C#" Value="public void RenderToDrawableAlpha (Gdk.Drawable drawable, int src_x, int src_y, int dest_x, int dest_y, int width, int height, Gdk.PixbufAlphaMode alpha_mode, int alpha_threshold, Gdk.RgbDither dither, int x_dither, int y_dither);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="drawable" Type="Gdk.Drawable" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
<Parameter Name="alpha_mode" Type="Gdk.PixbufAlphaMode" />
|
|
<Parameter Name="alpha_threshold" Type="System.Int32" />
|
|
<Parameter Name="dither" Type="Gdk.RgbDither" />
|
|
<Parameter Name="x_dither" Type="System.Int32" />
|
|
<Parameter Name="y_dither" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="drawable">To be added: an object of type 'Gdk.Drawable'</param>
|
|
<param name="src_x">To be added: an object of type 'int'</param>
|
|
<param name="src_y">To be added: an object of type 'int'</param>
|
|
<param name="dest_x">To be added: an object of type 'int'</param>
|
|
<param name="dest_y">To be added: an object of type 'int'</param>
|
|
<param name="width">To be added: an object of type 'int'</param>
|
|
<param name="height">To be added: an object of type 'int'</param>
|
|
<param name="alpha_mode">To be added: an object of type 'Gdk.PixbufAlphaMode'</param>
|
|
<param name="alpha_threshold">To be added: an object of type 'int'</param>
|
|
<param name="dither">To be added: an object of type 'Gdk.RgbDither'</param>
|
|
<param name="x_dither">To be added: an object of type 'int'</param>
|
|
<param name="y_dither">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Savev">
|
|
<MemberSignature Language="C#" Value="public bool Savev (string filename, string type, string option_keys, string option_values);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="filename">To be added: an object of type 'string'</param>
|
|
<param name="type">To be added: an object of type 'string'</param>
|
|
<param name="option_keys">To be added: an object of type 'string'</param>
|
|
<param name="option_values">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<returns>An instance of Pixbuf, wrapping the C object.</returns>
|
|
<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 (Gdk.Colorspace colorspace, bool has_alpha, int bits_per_sample, int width, int height);" />
|
|
<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>
|
|
<summary>Constructor</summary>
|
|
<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>
|
|
<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 (string filename);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates Pixbuf from image file.</summary>
|
|
<param name="filename">Filename with the image</param>
|
|
<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 (Gdk.Pixbuf src_pixbuf, int src_x, int src_y, int width, int height);" />
|
|
<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>
|
|
<summary>Creates a sub-Pixbuf from an existing one.</summary>
|
|
<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>
|
|
<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="BitsPerSample">
|
|
<MemberSignature Language="C#" Value="public int BitsPerSample { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Number of bits per color sample in a pixbuf.</summary>
|
|
<returns>The number of bits per color sample in the pixbuf</returns>
|
|
<remarks>None.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Height">
|
|
<MemberSignature Language="C#" Value="public int Height { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Height of the image</summary>
|
|
<returns>
|
|
<para>The height in pixels of the image</para>
|
|
</returns>
|
|
<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="HasAlpha">
|
|
<MemberSignature Language="C#" Value="public bool HasAlpha { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Returns whether the Pixbuf contains an alpha channel</summary>
|
|
<returns>
|
|
<see langword="true" /> if the image contains an Alpha
|
|
channel, <see langword="false" /> otherwise.</returns>
|
|
<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="Width">
|
|
<MemberSignature Language="C#" Value="public int Width { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The width of the image</summary>
|
|
<returns>
|
|
<para>The width in pixels of the image</para>
|
|
</returns>
|
|
<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>
|
|
<Member MemberName="NChannels">
|
|
<MemberSignature Language="C#" Value="public int NChannels { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The number of channels on a Pixbuf</summary>
|
|
<returns>Returns the number of channels on a Pixbuf</returns>
|
|
<remarks>
|
|
The possible values are 3 (for RGB encoding) and 4 (for RGB
|
|
with an alpha transparency channel encoding.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Rowstride">
|
|
<MemberSignature Language="C#" Value="public int Rowstride { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Rowstride of the Pixbuf</summary>
|
|
<returns>The rowstride property for the Pixbuf</returns>
|
|
<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="Colorspace">
|
|
<MemberSignature Language="C#" Value="public Gdk.Colorspace Colorspace { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Colorspace</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The colorspace for this Pixbuf</summary>
|
|
<returns>The colorspace used by this Pixbuf</returns>
|
|
<remarks>
|
|
<para>
|
|
Currently Pixbuf only support the RGB colorspace.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateFromDrawable">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf CreateFromDrawable (Gdk.Drawable src, Gdk.Colormap cmap, int src_x, int src_y, int dest_x, int dest_y, int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="src" Type="Gdk.Drawable" />
|
|
<Parameter Name="cmap" Type="Gdk.Colormap" />
|
|
<Parameter Name="src_x" Type="System.Int32" />
|
|
<Parameter Name="src_y" Type="System.Int32" />
|
|
<Parameter Name="dest_x" Type="System.Int32" />
|
|
<Parameter Name="dest_y" Type="System.Int32" />
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="src">To be added: an object of type 'Gdk.Drawable'</param>
|
|
<param name="cmap">To be added: an object of type 'Gdk.Colormap'</param>
|
|
<param name="src_x">To be added: an object of type 'int'</param>
|
|
<param name="src_y">To be added: an object of type 'int'</param>
|
|
<param name="dest_x">To be added: an object of type 'int'</param>
|
|
<param name="dest_y">To be added: an object of type 'int'</param>
|
|
<param name="width">To be added: an object of type 'int'</param>
|
|
<param name="height">To be added: an object of type 'int'</param>
|
|
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
|
<remarks>To be added</remarks>
|
|
</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);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="data">To be added: an object of type 'byte []'</param>
|
|
<param name="has_alpha">To be added: an object of type 'bool'</param>
|
|
<param name="bits_per_sample">To be added: an object of type 'int'</param>
|
|
<param name="width">To be added: an object of type 'int'</param>
|
|
<param name="height">To be added: an object of type 'int'</param>
|
|
<param name="rowstride">To be added: an object of type 'int'</param>
|
|
<param name="destroy_fn">To be added: an object of type 'Gdk.PixbufDestroyNotify'</param>
|
|
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (byte [] data, bool copy_pixels);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.Byte []" />
|
|
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="data">To be added: an object of type 'byte []'</param>
|
|
<param name="copy_pixels">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (int data_length, Void* data, bool copy_pixels);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="data_length">To be added: an object of type 'int'</param>
|
|
<param name="data">To be added: an object of type 'Void*'</param>
|
|
<param name="copy_pixels">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ErrorQuark">
|
|
<MemberSignature Language="C#" Value="public static int ErrorQuark ();" />
|
|
<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>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.Reflection.Assembly assembly, string resource);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param>
|
|
<param name="resource">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LoadFromResource">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf LoadFromResource (string resource);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="resource">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (System.IO.Stream stream);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<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);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="data">a <see cref="T:System.Byte[]" /></param>
|
|
<param name="colorspace">a <see cref="T:Gdk.Colorspace" /></param>
|
|
<param name="has_alpha">a <see cref="T:System.Boolean" /></param>
|
|
<param name="bits_per_sample">a <see cref="T:System.Int32" /></param>
|
|
<param name="width">a <see cref="T:System.Int32" /></param>
|
|
<param name="height">a <see cref="T:System.Int32" /></param>
|
|
<param name="rowstride">a <see cref="T:System.Int32" /></param>
|
|
<param name="destroy_fn">a <see cref="T:Gdk.PixbufDestroyNotify" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (int data_length, byte [] data, bool copy_pixels);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="data_length">a <see cref="T:System.Int32" /></param>
|
|
<param name="data">a <see cref="T:System.Byte[]" /></param>
|
|
<param name="copy_pixels">a <see cref="T:System.Boolean" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Pixbuf (string [] data);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="data" Type="System.String[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="data">a <see cref="T:System.String[]" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>GLib.GType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:GLib.GType" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Pixbuf (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>This is a constructor used by derivative types of <see cref="T:Gdk.Pixbuf" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Formats">
|
|
<MemberSignature Language="C#" Value="public static Gdk.PixbufFormat [] Formats { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.PixbufFormat[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:Gdk.PixbufFormat[]" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Pixels">
|
|
<MemberSignature Language="C#" Value="public IntPtr Pixels { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:System.IntPtr" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |