110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/direct3d11/CounterMetadata11.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 "Enums11.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace Direct3D11\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Contains the results of a request for counter information.\r
  32                 /// </summary>\r
  33                 public value class CounterMetadata : System::IEquatable<CounterMetadata>\r
  34                 {\r
  35                 private:\r
  36                         CounterType m_Type;\r
  37                         int m_ActiveCounters;\r
  38                         System::String^ m_Name;\r
  39                         System::String^ m_Units;\r
  40                         System::String^ m_Description;\r
  41 \r
  42                 internal:\r
  43                         CounterMetadata( CounterType type, int count, System::String^ name, System::String^ units, System::String^ description );\r
  44                         \r
  45                 public:\r
  46                         /// <summary>\r
  47                         /// The data type of the counter.\r
  48                         /// </summary>\r
  49                         property CounterType Type\r
  50                         {\r
  51                                 CounterType get();\r
  52                         }\r
  53                         \r
  54                         /// <summary>\r
  55                         /// The number of hardware counters needed for the desired counter type to be created. All instances of the same counter type use the same hardware counters.\r
  56                         /// </summary>\r
  57                         property int HardwareCounterCount\r
  58                         {\r
  59                                 int get();\r
  60                         }\r
  61                         \r
  62                         /// <summary>\r
  63                         /// The name of the counter.\r
  64                         /// </summary>\r
  65                         property System::String^ Name\r
  66                         {\r
  67                                 System::String^ get();\r
  68                         }\r
  69                         \r
  70                         /// <summary>\r
  71                         /// The name of the units the counter measures.\r
  72                         /// </summary>\r
  73                         property System::String^ Units\r
  74                         {\r
  75                                 System::String^ get();\r
  76                         }\r
  77                         \r
  78                         /// <summary>\r
  79                         /// A brief description of the counter.\r
  80                         /// </summary>\r
  81                         property System::String^ Description\r
  82                         {\r
  83                                 System::String^ get();\r
  84                         }\r
  85 \r
  86                         /// <summary>\r
  87                         /// Tests for equality between two objects.\r
  88                         /// </summary>\r
  89                         /// <param name="left">The first value to compare.</param>\r
  90                         /// <param name="right">The second value to compare.</param>\r
  91                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  92                         static bool operator == ( CounterMetadata left, CounterMetadata right );\r
  93 \r
  94                         /// <summary>\r
  95                         /// Tests for inequality between two objects.\r
  96                         /// </summary>\r
  97                         /// <param name="left">The first value to compare.</param>\r
  98                         /// <param name="right">The second value to compare.</param>\r
  99                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 100                         static bool operator != ( CounterMetadata left, CounterMetadata right );\r
 101 \r
 102                         /// <summary>\r
 103                         /// Returns the hash code for this instance.\r
 104                         /// </summary>\r
 105                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 106                         virtual int GetHashCode() override;\r
 107 \r
 108                         /// <summary>\r
 109                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 110                         /// </summary>\r
 111                         /// <param name="obj">Object to make the comparison with.</param>\r
 112                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 113                         virtual bool Equals( System::Object^ obj ) override;\r
 114 \r
 115                         /// <summary>\r
 116                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 117                         /// </summary>\r
 118                         /// <param name="other">Object to make the comparison with.</param>\r
 119                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 120                         virtual bool Equals( CounterMetadata other );\r
 121 \r
 122                         /// <summary>\r
 123                         /// Determines whether the specified object instances are considered equal. \r
 124                         /// </summary>\r
 125                         /// <param name="value1">The first value to compare.</param>\r
 126                         /// <param name="value2">The second value to compare.</param>\r
 127                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 128                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 129                         static bool Equals( CounterMetadata% value1, CounterMetadata% value2 );\r
 130                 };\r
 131         }\r
 132 };