Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[OpenTK] Rearranged MouseCursor parameters

MouseCursor and WindowIcon now match GL.TexImage2D in the way they
arrange their parameters. The expected values of each parameter are now
documented.
  • Loading branch information...
commit c8c0d32fcce84f50a1dbe9b8a6e5e8fdc4e8d139 1 parent 8568e6d
@thefiddler thefiddler authored
View
4 Source/Examples/OpenTK/GameWindow/MouseCursorSimple.cs
@@ -13,7 +13,7 @@ namespace Examples.Tutorial
/// <summary>
/// Demonstrates the MouseCursor class.
/// </summary>
- [Example("MouseCursor Simple", ExampleCategory.OpenTK, "GameWindow", 1, Documentation = "MouseCursorSimple")]
+ [Example("Custom MouseCursor", ExampleCategory.OpenTK, "GameWindow", 1, Documentation = "MouseCursorSimple")]
public class MouseCursorSimple : GameWindow
{
readonly MouseCursor MyCursor;
@@ -31,7 +31,7 @@ public MouseCursorSimple()
System.Drawing.Imaging.PixelFormat.Format32bppPArgb);
MyCursor = new OpenTK.MouseCursor(
- data.Scan0, bitmap.Width, bitmap.Height, 0, 0);
+ 0, 0, data.Width, data.Height, data.Scan0);
Cursor = MyCursor;
}
}
View
50 Source/OpenTK/MouseCursor.cs
@@ -38,7 +38,7 @@ public sealed class MouseCursor : WindowIcon
{
static readonly MouseCursor default_cursor = new MouseCursor();
static readonly MouseCursor empty_cursor = new MouseCursor(
- new byte[16 * 16 * 4], 16, 16, 0, 0);
+ 0, 0, 16, 16, new byte[16 * 16 * 4]);
int x;
int y;
@@ -47,9 +47,28 @@ public sealed class MouseCursor : WindowIcon
{
}
- // Todo: make public when byte-order issues are resolved
- public MouseCursor(byte[] argb, int width, int height, int hotx, int hoty)
- : base(argb, width, height)
+ /// <summary>
+ /// Initializes a new <see cref="MouseCursor"/> instance from a
+ /// contiguous array of BGRA pixels.
+ /// Each pixel is composed of 4 bytes, representing B, G, R and A values,
+ /// respectively. For correct antialiasing of translucent cursors,
+ /// the B, G and R components should be premultiplied with the A component:
+ /// <code>
+ /// B = (byte)((B * A) / 255)
+ /// G = (byte)((G * A) / 255)
+ /// R = (byte)((R * A) / 255)
+ /// </code>
+ /// </summary>
+ /// <param name="hotx">The x-coordinate of the cursor hotspot, in the range [0, width]</param>
+ /// <param name="hoty">The y-coordinate of the cursor hotspot, in the range [0, height]</param>
+ /// <param name="width">The width of the cursor data, in pixels.</param>
+ /// <param name="height">The height of the cursor data, in pixels.</param>
+ /// <param name="data">
+ /// A byte array representing the cursor image,
+ /// laid out as a contiguous array of BGRA pixels.
+ /// </param>
+ public MouseCursor(int hotx, int hoty, int width, int height, byte[] data)
+ : base(width, height, data)
{
if (hotx < 0 || hotx >= Width || hoty < 0 || hoty >= Height)
throw new ArgumentOutOfRangeException();
@@ -58,8 +77,27 @@ public MouseCursor(byte[] argb, int width, int height, int hotx, int hoty)
y = hoty;
}
- public MouseCursor(IntPtr argb, int width, int height, int hotx, int hoty)
- : base(argb, width, height)
+ /// <summary>
+ /// Initializes a new <see cref="MouseCursor"/> instance from a
+ /// contiguous array of BGRA pixels.
+ /// Each pixel is composed of 4 bytes, representing B, G, R and A values,
+ /// respectively. For correct antialiasing of translucent cursors,
+ /// the B, G and R components should be premultiplied with the A component:
+ /// <code>
+ /// B = (byte)((B * A) / 255)
+ /// G = (byte)((G * A) / 255)
+ /// R = (byte)((R * A) / 255)
+ /// </code>
+ /// </summary>
+ /// <param name="hotx">The x-coordinate of the cursor hotspot, in the range [0, width]</param>
+ /// <param name="hoty">The y-coordinate of the cursor hotspot, in the range [0, height]</param>
+ /// <param name="width">The width of the cursor data, in pixels.</param>
+ /// <param name="height">The height of the cursor data, in pixels.</param>
+ /// <param name="data">
+ /// A pointer to the cursor image, laid out as a contiguous array of BGRA pixels.
+ /// </param>
+ public MouseCursor(int hotx, int hoty, int width, int height, IntPtr data)
+ : base(width, height, data)
{
if (hotx < 0 || hotx >= Width || hoty < 0 || hoty >= Height)
throw new ArgumentOutOfRangeException();
View
2  Source/OpenTK/Platform/MacOS/CocoaNativeWindow.cs
@@ -987,7 +987,7 @@ static IntPtr ToNSCursor(MouseCursor cursor)
{
for (int x = 0; x < cursor.Width; x++)
{
- uint argb = unchecked((uint)BitConverter.ToInt32(cursor.Argb, i));
+ uint argb = unchecked((uint)BitConverter.ToInt32(cursor.Data, i));
if (BitConverter.IsLittleEndian)
{
argb =
View
2  Source/OpenTK/Platform/SDL2/Sdl2NativeWindow.cs
@@ -493,7 +493,7 @@ public MouseCursor Cursor
// the rgba values supplied by the user
unsafe
{
- fixed (byte* pixels = value.Argb)
+ fixed (byte* pixels = value.Data)
{
IntPtr cursor_surface =
SDL.CreateRGBSurfaceFrom(
View
2  Source/OpenTK/Platform/Windows/WinGLNative.cs
@@ -1219,7 +1219,7 @@ public MouseCursor Cursor
Bitmap bmp;
unsafe
{
- fixed (byte* pixels = value.Argb)
+ fixed (byte* pixels = value.Data)
{
bmp = new Bitmap(value.Width, value.Height, stride,
System.Drawing.Imaging.PixelFormat.Format32bppArgb,
View
2  Source/OpenTK/Platform/X11/X11GLNative.cs
@@ -1483,7 +1483,7 @@ public MouseCursor Cursor
}
else
{
- fixed(byte* pixels = value.Argb)
+ fixed(byte* pixels = value.Data)
{
var xcursorimage = Functions.XcursorImageCreate(value.Width, value.Height);
xcursorimage->xhot = (uint)value.X;
View
29 Source/OpenTK/WindowIcon.cs
@@ -38,10 +38,14 @@ namespace OpenTK
/// </summary>
public class WindowIcon
{
- byte[] argb;
+ byte[] data;
int width;
int height;
+ /// \internal
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OpenTK.WindowIcon"/> class.
+ /// </summary>
internal protected WindowIcon()
{
}
@@ -55,36 +59,31 @@ internal protected WindowIcon()
this.height = height;
}
- internal WindowIcon(byte[] argb, int width, int height)
+ internal WindowIcon(int width, int height, byte[] data)
: this(width, height)
{
- if (argb == null)
+ if (data == null)
throw new ArgumentNullException();
- if (argb.Length < Width * Height * 4)
+ if (data.Length < Width * Height * 4)
throw new ArgumentOutOfRangeException();
- this.argb = argb;
+ this.data = data;
}
- internal WindowIcon(IntPtr argb, int width, int height)
+ internal WindowIcon(int width, int height, IntPtr data)
: this(width, height)
{
- if (argb == IntPtr.Zero)
+ if (data == IntPtr.Zero)
throw new ArgumentNullException();
// We assume that width and height are correctly set.
// If they are not, we will read garbage and probably
// crash.
- this.argb = new byte[width * height * 4];
- for (int y = 0; y < height; y++)
- {
- var stride = width * 4;
- var offset = new IntPtr(argb.ToInt64() + y * stride);
- Marshal.Copy(offset, Argb, y * stride, stride);
- }
+ this.data = new byte[width * height * 4];
+ Marshal.Copy(data, this.data, 0, this.data.Length);
}
- internal byte[] Argb { get { return argb; } }
+ internal byte[] Data { get { return data; } }
internal int Width { get { return width; } }
internal int Height { get { return height; } }
}
Please sign in to comment.
Something went wrong with that request. Please try again.