SlimDXc_Jun2010(VC++2008)/source/direct3d11/TimestampQueryData11.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 namespace SlimDX
  25 {
  26         namespace Direct3D11
  27         {
  28                 /// <summary>
  29                 /// Contains query information about the reliability of a timestamp query.
  30                 /// </summary>
  31                 /// <unmanaged>D3D11_QUERY_DATA_TIMESTAMP_DISJOINT</unmanaged>
  32                 public value class TimestampQueryData : System::IEquatable<TimestampQueryData>
  33                 {
  34                 internal:
  35                         TimestampQueryData( const D3D11_QUERY_DATA_TIMESTAMP_DISJOINT& native );
  36
  37                         D3D11_QUERY_DATA_TIMESTAMP_DISJOINT CreateNativeVersion();
  38
  39                 public:
  40                         /// <summary>
  41                         /// How frequently the GPU counter increments in Hz.
  42                         /// </summary>
  43                         property long Frequency;
  44
  45                         /// <summary>
  46                         /// If this is <c>true</c>, something occurred in between the query's Begin and End calls that caused the
  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.
  48                         /// The timestamp returned by GetData for a timestamp query is only reliable if IsDisjointed is <c>false</c>.
  49                         /// </summary>
  50                         property bool IsDisjointed;
  51
  52                         /// <summary>
  53                         /// Tests for equality between two TimestampQueryDatas.
  54                         /// </summary>
  55                         /// <param name="left">The first value to compare.</param>
  56                         /// <param name="right">The second value to compare.</param>
  57                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  58                         static bool operator == ( TimestampQueryData left, TimestampQueryData right );
  59
  60                         /// <summary>
  61                         /// Tests for inequality between two TimestampQueryDatas.
  62                         /// </summary>
  63                         /// <param name="left">The first value to compare.</param>
  64                         /// <param name="right">The second value to compare.</param>
  65                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  66                         static bool operator != ( TimestampQueryData left, TimestampQueryData right );
  67
  68                         /// <summary>
  69                         /// Returns the hash code for this instance.
  70                         /// </summary>
  71                         /// <returns>A 32-bit signed integer hash code.</returns>
  72                         virtual int GetHashCode() override;
  73
  74                         /// <summary>
  75                         /// Returns a value indicating whether this instance is equal to the specified object.
  76                         /// </summary>
  77                         /// <param name="obj">An object to compare with this instance.</param>
  78                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>
  79                         virtual bool Equals( System::Object^ obj ) override;
  80
  81                         /// <summary>
  82                         /// Returns a value indicating whether this instance is equal to the specified object.
  83                         /// </summary>
  84                         /// <param name="other">A <see cref="TimestampQueryData"/> to compare with this instance.</param>
  85                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>
  86                         virtual bool Equals( TimestampQueryData other );
  87
  88                         /// <summary>
  89                         /// Returns a value indicating whether the two BufferDescriptions are equivalent.
  90                         /// </summary>
  91                         /// <param name="value1">The first value to compare.</param>
  92                         /// <param name="value2">The second value to compare.</param>
  93                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>
  94                         static bool Equals( TimestampQueryData% value1, TimestampQueryData% value2 );
  95                 };
  96         }
  97 };