SlimDXc_Jun2010(VC++2008)/source/direct3d9/PaletteEntry.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 namespace SlimDX\r
  25 {\r
  26         namespace Direct3D9\r
  27         {\r
  28                 /// <summary>Specifies the color and usage of an entry in a logical palette.</summary>\r
  29                 /// <unmanaged>PALETTEENTRY</unmanaged>\r
  30                 [System::Runtime::InteropServices::StructLayout(System::Runtime::InteropServices::LayoutKind::Sequential)]\r
  31                 public value class PaletteEntry : System::IEquatable<PaletteEntry>\r
  32                 {\r
  33                 public:\r
  34                         /// <summary>\r
  35                         /// Gets or sets the red component of the palette entry.\r
  36                         /// </summary>\r
  37                         property System::Byte Red;\r
  38 \r
  39                         /// <summary>\r
  40                         /// Gets or sets the green component of the palette entry.\r
  41                         /// </summary>\r
  42                         property System::Byte Green;\r
  43 \r
  44                         /// <summary>\r
  45                         /// Gets or sets the blue component of the palette entry.\r
  46                         /// </summary>\r
  47                         property System::Byte Blue;\r
  48 \r
  49                         /// <summary>\r
  50                         /// Gets or sets the alpha component of the palette entry.\r
  51                         /// </summary>\r
  52                         property System::Byte Flags;\r
  53 \r
  54                         /// <summary>\r
  55                         /// Tests for equality between two objects.\r
  56                         /// </summary>\r
  57                         /// <param name="left">The first value to compare.</param>\r
  58                         /// <param name="right">The second value to compare.</param>\r
  59                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  60                         static bool operator == ( PaletteEntry left, PaletteEntry right );\r
  61 \r
  62                         /// <summary>\r
  63                         /// Tests for inequality between two objects.\r
  64                         /// </summary>\r
  65                         /// <param name="left">The first value to compare.</param>\r
  66                         /// <param name="right">The second value to compare.</param>\r
  67                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  68                         static bool operator != ( PaletteEntry left, PaletteEntry right );\r
  69 \r
  70                         /// <summary>\r
  71                         /// Returns the hash code for this instance.\r
  72                         /// </summary>\r
  73                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  74                         virtual int GetHashCode() override;\r
  75 \r
  76                         /// <summary>\r
  77                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  78                         /// </summary>\r
  79                         /// <param name="obj">Object to make the comparison with.</param>\r
  80                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  81                         virtual bool Equals( System::Object^ obj ) override;\r
  82 \r
  83                         /// <summary>\r
  84                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
  85                         /// </summary>\r
  86                         /// <param name="other">Object to make the comparison with.</param>\r
  87                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  88                         virtual bool Equals( PaletteEntry other );\r
  89 \r
  90                         /// <summary>\r
  91                         /// Determines whether the specified object instances are considered equal. \r
  92                         /// </summary>\r
  93                         /// <param name="value1">The first value to compare.</param>\r
  94                         /// <param name="value2">The second value to compare.</param>\r
  95                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
  96                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
  97                         static bool Equals( PaletteEntry% value1, PaletteEntry% value2 );\r
  98                 };\r
  99         }\r
 100 }