110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/direct3d10/QueryDescription.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 Direct3D10\r
  29         {       \r
  30                 /// <summary>\r
  31                 /// Describes a query object.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>D3D10_QUERY_DESC</unmanaged>\r
  34                 public value class QueryDescription : System::IEquatable<QueryDescription>\r
  35                 {\r
  36                 private:\r
  37                         QueryType m_Query;\r
  38                         QueryFlags m_MiscFlags;\r
  39 \r
  40                 internal:\r
  41                         QueryDescription( const D3D10_QUERY_DESC& native );\r
  42                         \r
  43                         D3D10_QUERY_DESC CreateNativeVersion();\r
  44                         \r
  45                 public:\r
  46                         /// <summary>\r
  47                         /// Gets or sets the query type.\r
  48                         /// </summary>\r
  49                         property QueryType Type\r
  50                         {\r
  51                                 QueryType get();\r
  52                                 void set( QueryType value );\r
  53                         }\r
  54 \r
  55                         /// <summary>\r
  56                         /// Gets or sets the query flags.\r
  57                         /// </summary>\r
  58                         property QueryFlags Flags\r
  59                         {\r
  60                                 QueryFlags get();\r
  61                                 void set( QueryFlags value );\r
  62                         }\r
  63                         \r
  64                         /// <summary>\r
  65                         /// Constructs a new QueryDescription object.\r
  66                         /// </summary>\r
  67                         /// <param name="type">The query type.</param>\r
  68                         /// <param name="flags">Query options.</param>\r
  69                         QueryDescription( QueryType type, QueryFlags flags );\r
  70                 \r
  71                         /// <summary>\r
  72                         /// Tests for equality between two QueryDescriptions.\r
  73                         /// </summary>\r
  74                         /// <param name="left">The first value to compare.</param>\r
  75                         /// <param name="right">The second value to compare.</param>\r
  76                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  77                         static bool operator == ( QueryDescription left, QueryDescription right );\r
  78                         \r
  79                         /// <summary>\r
  80                         /// Tests for inequality between two QueryDescriptions.\r
  81                         /// </summary>\r
  82                         /// <param name="left">The first value to compare.</param>\r
  83                         /// <param name="right">The second value to compare.</param>\r
  84                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  85                         static bool operator != ( QueryDescription left, QueryDescription right );\r
  86                         \r
  87                         /// <summary>\r
  88                         /// Returns the hash code for this instance.\r
  89                         /// </summary>\r
  90                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  91                         virtual int GetHashCode() override;\r
  92                         \r
  93                         /// <summary>\r
  94                         /// Returns a value indicating whether this instance is equal to the specified object.\r
  95                         /// </summary>\r
  96                         /// <param name="obj">An object to compare with this instance.</param>\r
  97                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
  98                         virtual bool Equals( System::Object^ obj ) override;\r
  99 \r
 100                         /// <summary>\r
 101                         /// Returns a value indicating whether this instance is equal to the specified object.\r
 102                         /// </summary>\r
 103                         /// <param name="other">A <see cref="QueryDescription"/> to compare with this instance.</param>\r
 104                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
 105                         virtual bool Equals( QueryDescription other );\r
 106 \r
 107                         /// <summary>\r
 108                         /// Returns a value indicating whether the two BufferDescriptions are equivalent.\r
 109                         /// </summary>\r
 110                         /// <param name="value1">The first value to compare.</param>\r
 111                         /// <param name="value2">The second value to compare.</param>\r
 112                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>\r
 113                         static bool Equals( QueryDescription% value1, QueryDescription% value2 );\r
 114                 };\r
 115         }\r
 116 };