SlimDXc_Jun2010(VC++2008)/source/direct3d11/TimestampQueryData11.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 Direct3D11\r
  27         {\r
  28                 /// <summary>\r
  29                 /// Contains query information about the reliability of a timestamp query.\r
  30                 /// </summary>\r
  31                 /// <unmanaged>D3D11_QUERY_DATA_TIMESTAMP_DISJOINT</unmanaged>\r
  32                 public value class TimestampQueryData : System::IEquatable<TimestampQueryData>\r
  33                 {\r
  34                 internal:\r
  35                         TimestampQueryData( const D3D11_QUERY_DATA_TIMESTAMP_DISJOINT& native );\r
  36                         \r
  37                         D3D11_QUERY_DATA_TIMESTAMP_DISJOINT CreateNativeVersion();\r
  38                         \r
  39                 public:\r
  40                         /// <summary>\r
  41                         /// How frequently the GPU counter increments in Hz.\r
  42                         /// </summary>\r
  43                         property long Frequency;\r
  44 \r
  45                         /// <summary>\r
  46                         /// If this is <c>true</c>, something occurred in between the query's Begin and End calls that caused the \r
  47                         /// timestamp counter to become discontinuous or disjoint, such as unplugging the AC chord on a laptop, overheating, or throttling up/down due to laptop savings events. \r
  48                         /// The timestamp returned by GetData for a timestamp query is only reliable if IsDisjointed is <c>false</c>.\r
  49                         /// </summary>\r
  50                         property bool IsDisjointed;\r
  51                 \r
  52                         /// <summary>\r
  53                         /// Tests for equality between two TimestampQueryDatas.\r
  54                         /// </summary>\r
  55                         /// <param name="left">The first value to compare.</param>\r
  56                         /// <param name="right">The second value to compare.</param>\r
  57                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  58                         static bool operator == ( TimestampQueryData left, TimestampQueryData right );\r
  59                         \r
  60                         /// <summary>\r
  61                         /// Tests for inequality between two TimestampQueryDatas.\r
  62                         /// </summary>\r
  63                         /// <param name="left">The first value to compare.</param>\r
  64                         /// <param name="right">The second value to compare.</param>\r
  65                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  66                         static bool operator != ( TimestampQueryData left, TimestampQueryData right );\r
  67                         \r
  68                         /// <summary>\r
  69                         /// Returns the hash code for this instance.\r
  70                         /// </summary>\r
  71                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  72                         virtual int GetHashCode() override;\r
  73                         \r
  74                         /// <summary>\r
  75                         /// Returns a value indicating whether this instance is equal to the specified object.\r
  76                         /// </summary>\r
  77                         /// <param name="obj">An object to compare with this instance.</param>\r
  78                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
  79                         virtual bool Equals( System::Object^ obj ) override;\r
  80 \r
  81                         /// <summary>\r
  82                         /// Returns a value indicating whether this instance is equal to the specified object.\r
  83                         /// </summary>\r
  84                         /// <param name="other">A <see cref="TimestampQueryData"/> to compare with this instance.</param>\r
  85                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
  86                         virtual bool Equals( TimestampQueryData other );\r
  87 \r
  88                         /// <summary>\r
  89                         /// Returns a value indicating whether the two BufferDescriptions are equivalent.\r
  90                         /// </summary>\r
  91                         /// <param name="value1">The first value to compare.</param>\r
  92                         /// <param name="value2">The second value to compare.</param>\r
  93                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>\r
  94                         static bool Equals( TimestampQueryData% value1, TimestampQueryData% value2 );\r
  95                 };\r
  96         }\r
  97 };