SlimDXc_Jun2010(VC++2008)/source/direct3d10/ResourceRegion.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 Direct3D10\r
  27         {\r
  28                 /// <summary>\r
  29                 /// Represents a 3D region of a resource's data.\r
  30                 /// </summary>\r
  31                 /// <unmanaged>D3D10_BOX</unmanaged>\r
  32                 public value class ResourceRegion : System::IEquatable<ResourceRegion>\r
  33                 {\r
  34                 private:\r
  35                         UINT m_Left;\r
  36                         UINT m_Top;\r
  37                         UINT m_Front;\r
  38                         UINT m_Right;\r
  39                         UINT m_Bottom;\r
  40                         UINT m_Back;\r
  41 \r
  42                 internal:\r
  43                         ResourceRegion( const D3D10_BOX& native );\r
  44                         \r
  45                         D3D10_BOX CreateNativeVersion();\r
  46                         \r
  47                 public:\r
  48                         /// <summary>\r
  49                         /// Gets or sets the left boundary of the region.\r
  50                         /// </summary>\r
  51                         property int Left\r
  52                         {\r
  53                                 int get();\r
  54                                 void set( int value );\r
  55                         }\r
  56                         \r
  57                         /// <summary>\r
  58                         /// Gets or sets the top boundary of the region.\r
  59                         /// </summary>\r
  60                         property int Top\r
  61                         {\r
  62                                 int get();\r
  63                                 void set( int value );\r
  64                         }\r
  65                         \r
  66                         /// <summary>\r
  67                         /// Gets or sets the front boundary of the region.\r
  68                         /// </summary>\r
  69                         property int Front\r
  70                         {\r
  71                                 int get();\r
  72                                 void set( int value );\r
  73                         }\r
  74                         \r
  75                         /// <summary>\r
  76                         /// Gets or sets the right boundary of the region.\r
  77                         /// </summary>\r
  78                         property int Right\r
  79                         {\r
  80                                 int get();\r
  81                                 void set( int value );\r
  82                         }\r
  83                         \r
  84                         /// <summary>\r
  85                         /// Gets or sets the bottom boundary of the region.\r
  86                         /// </summary>\r
  87                         property int Bottom\r
  88                         {\r
  89                                 int get();\r
  90                                 void set( int value );\r
  91                         }\r
  92                         \r
  93                         /// <summary>\r
  94                         /// Gets or sets the back boundary of the region.\r
  95                         /// </summary>\r
  96                         property int Back\r
  97                         {\r
  98                                 int get();\r
  99                                 void set( int value );\r
 100                         }\r
 101 \r
 102                         /// <summary>\r
 103                         /// Tests for equality between two ResourceRegions.\r
 104                         /// </summary>\r
 105                         /// <param name="left">The first value to compare.</param>\r
 106                         /// <param name="right">The second value to compare.</param>\r
 107                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 108                         static bool operator == ( ResourceRegion left, ResourceRegion right );\r
 109                         \r
 110                         /// <summary>\r
 111                         /// Tests for inequality between two ResourceRegions.\r
 112                         /// </summary>\r
 113                         /// <param name="left">The first value to compare.</param>\r
 114                         /// <param name="right">The second value to compare.</param>\r
 115                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 116                         static bool operator != ( ResourceRegion left, ResourceRegion right );\r
 117 \r
 118                         /// <summary>\r
 119                         /// Returns the hash code for this instance.\r
 120                         /// </summary>\r
 121                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 122                         virtual int GetHashCode() override;\r
 123                         \r
 124                         /// <summary>\r
 125                         /// Returns a value indicating whether this instance is equal to the specified object.\r
 126                         /// </summary>\r
 127                         /// <param name="obj">An object to compare with this instance.</param>\r
 128                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
 129                         virtual bool Equals( System::Object^ obj ) override;\r
 130                         \r
 131                         /// <summary>\r
 132                         /// Returns a value indicating whether this instance is equal to the specified object.\r
 133                         /// </summary>\r
 134                         /// <param name="other">A <see cref="ResourceRegion"/> to compare with this instance.</param>\r
 135                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
 136                         virtual bool Equals( ResourceRegion other );\r
 137                         \r
 138                         /// <summary>\r
 139                         /// Returns a value indicating whether the two ResourceRegions are equivalent.\r
 140                         /// </summary>\r
 141                         /// <param name="value1">The first value to compare.</param>\r
 142                         /// <param name="value2">The second value to compare.</param>\r
 143                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>\r
 144                         static bool Equals( ResourceRegion% value1, ResourceRegion% value2 );\r
 145                 };\r
 146         }\r
 147 };