110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/dxgi/AdapterDescription1.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 #include "Enums.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace DXGI\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Describes various properties of an Adapter1.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>DXGI_ADAPTER_DESC1</unmanaged>\r
  34                 public value class AdapterDescription1 : System::IEquatable<AdapterDescription1>\r
  35                 {\r
  36                         System::String^ m_Description;\r
  37                         int m_VendorId;\r
  38                         int m_DeviceId;\r
  39                         int m_SubSysId;\r
  40                         int m_Revision;\r
  41                         SIZE_T m_DedicatedVideoMemory;\r
  42                         SIZE_T m_DedicatedSystemMemory;\r
  43                         SIZE_T m_SharedSystemMemory;\r
  44                         System::Int64 m_Luid;\r
  45                         AdapterFlags m_Flags;\r
  46 \r
  47                 internal:\r
  48                         AdapterDescription1( const DXGI_ADAPTER_DESC1& native );\r
  49 \r
  50                 public:\r
  51                         /// <summary>\r
  52                         /// Gets the adapter's description.\r
  53                         /// </summary>\r
  54                         property System::String^ Description\r
  55                         {\r
  56                                 System::String^ get();\r
  57                         }\r
  58                         \r
  59                         /// <summary>\r
  60                         /// Gets the adapter's vendor ID.\r
  61                         /// </summary>\r
  62                         property int VendorId\r
  63                         {\r
  64                                 int get();\r
  65                         }\r
  66 \r
  67                         /// <summary>\r
  68                         /// Gets the adapter's device ID.\r
  69                         /// </summary>\r
  70                         property int DeviceId\r
  71                         {\r
  72                                 int get();\r
  73                         }\r
  74 \r
  75                         /// <summary>\r
  76                         /// Gets the adapter's subsystem ID.\r
  77                         /// </summary>\r
  78                         property int SubsystemId\r
  79                         {\r
  80                                 int get();\r
  81                         }\r
  82 \r
  83                         /// <summary>\r
  84                         /// Gets the adapter's revision number.\r
  85                         /// </summary>\r
  86                         property int Revision\r
  87                         {\r
  88                                 int get();\r
  89                         }\r
  90 \r
  91                         /// <summary>\r
  92                         /// Gets the number of bytes of video memory not shared with the CPU.\r
  93                         /// </summary>\r
  94                         property System::Int64 DedicatedVideoMemory\r
  95                         {\r
  96                                 System::Int64 get();\r
  97                         }\r
  98 \r
  99                         /// <summary>\r
 100                         /// Gets the number of bytes of system memory not shared with the CPU.\r
 101                         /// </summary>\r
 102                         property System::Int64 DedicatedSystemMemory\r
 103                         {\r
 104                                 System::Int64 get();\r
 105                         }\r
 106 \r
 107                         /// <summary>\r
 108                         /// Gets the number of bytes of system memory shared with the CPU.\r
 109                         /// </summary>\r
 110                         property System::Int64 SharedSystemMemory\r
 111                         {\r
 112                                 System::Int64 get();\r
 113                         }\r
 114 \r
 115                         /// <summary>\r
 116                         /// Gets the adapter's unique identifier.\r
 117                         /// </summary>\r
 118                         property System::Int64 Luid\r
 119                         {\r
 120                                 System::Int64 get();\r
 121                         }\r
 122 \r
 123                         /// <summary>\r
 124                         /// Gets the adapter's flags, describing the adapter type.\r
 125                         /// </summary>\r
 126                         property AdapterFlags Flags\r
 127                         {\r
 128                                 AdapterFlags get();\r
 129                         }\r
 130 \r
 131                         /// <summary>\r
 132                         /// Tests for equality between two objects.\r
 133                         /// </summary>\r
 134                         /// <param name="left">The first value to compare.</param>\r
 135                         /// <param name="right">The second value to compare.</param>\r
 136                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 137                         static bool operator == ( AdapterDescription1 left, AdapterDescription1 right );\r
 138 \r
 139                         /// <summary>\r
 140                         /// Tests for inequality between two objects.\r
 141                         /// </summary>\r
 142                         /// <param name="left">The first value to compare.</param>\r
 143                         /// <param name="right">The second value to compare.</param>\r
 144                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 145                         static bool operator != ( AdapterDescription1 left, AdapterDescription1 right );\r
 146 \r
 147                         /// <summary>\r
 148                         /// Returns the hash code for this instance.\r
 149                         /// </summary>\r
 150                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 151                         virtual int GetHashCode() override;\r
 152 \r
 153                         /// <summary>\r
 154                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 155                         /// </summary>\r
 156                         /// <param name="obj">Object to make the comparison with.</param>\r
 157                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 158                         virtual bool Equals( System::Object^ obj ) override;\r
 159 \r
 160                         /// <summary>\r
 161                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 162                         /// </summary>\r
 163                         /// <param name="other">Object to make the comparison with.</param>\r
 164                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 165                         virtual bool Equals( AdapterDescription1 other );\r
 166 \r
 167                         /// <summary>\r
 168                         /// Determines whether the specified object instances are considered equal. \r
 169                         /// </summary>\r
 170                         /// <param name="value1">The first value to compare.</param>\r
 171                         /// <param name="value2">The second value to compare.</param>\r
 172                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 173                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 174                         static bool Equals( AdapterDescription1% value1, AdapterDescription1% value2 );\r
 175                 };\r
 176         }\r
 177 };\r