GtkSharp/doc/en/Gdk/Rgb.xml

214 lines
7.7 KiB
XML
Raw Normal View History

<Type Name="Rgb" FullName="Gdk.Rgb">
<TypeSignature Language="C#" Value="public class Rgb" Maintainer="auto" />
<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>To be added</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="FindColor">
<MemberSignature Language="C#" Value="public static void FindColor (Gdk.Colormap colormap, Gdk.Color color);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="color" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>
<p>
<paramref name="colormap" /> should be the colormap for the graphics context and
drawable you're using to draw. If you're drawing to a <see cref="T:Gtk.Widget" />,
call <see cref="M:Gtk.Widget.GetColormap" />.
</p>
<p>
<paramref name="color" /> should have its red, green, and blue fields initialized;
this method will fill in <paramref name="color" />'s pixel field with the best
matching pixel from a color cube. The color is then ready to be
used for drawing, e.g. you can call <see cref="M:Gdk.GC.SetForeground" /> which
expects "pixel" to be initialized.
</p>
<p>
In many cases, you can avoid this whole issue by setting
<see cref="P:Gdk.GC.RgbFgColor" /> or <see cref="P:Gdk.GC.RgbBgColor" />, which
do not expect "pixel" to be initialized in advance. If you use those
mutators, there's no need for calling this method.
</p>
</summary>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="color">a <see cref="T:Gdk.Color" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Ditherable">
<MemberSignature Language="C#" Value="public static bool Ditherable ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Rgb ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Basic constructor.</summary>
<returns>a <see cref="T:Gdk.Rgb" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MinColors">
<MemberSignature Language="C#" Value="public static int MinColors { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The minimum number of colors for this colormap.</summary>
<param name="value">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Visual">
<MemberSignature Language="C#" Value="public static Gdk.Visual Visual { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Visual" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Install">
<MemberSignature Language="C#" Value="public static bool Install { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Colormap">
<MemberSignature Language="C#" Value="public static Gdk.Colormap Colormap { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Colormap" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Verbose">
<MemberSignature Language="C#" Value="public static bool Verbose { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether or not to be verbose to the console about actions. Useful for debugging.</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GcSetForeground">
<MemberSignature Language="C#" Value="public static void GcSetForeground (Gdk.GC gc, uint rgb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="gc" Type="Gdk.GC" />
<Parameter Name="rgb" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gc">a <see cref="T:Gdk.GC" /></param>
<param name="rgb">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GcSetBackground">
<MemberSignature Language="C#" Value="public static void GcSetBackground (Gdk.GC gc, uint rgb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="gc" Type="Gdk.GC" />
<Parameter Name="rgb" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gc">a <see cref="T:Gdk.GC" /></param>
<param name="rgb">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XpixelFromRgb">
<MemberSignature Language="C#" Value="public static ulong XpixelFromRgb (uint rgb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rgb" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="rgb">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:System.UInt64" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Init">
<MemberSignature Language="C#" Value="public static void Init ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>