SlimDXc_Jun2010(VC++2008)/source/direct3d9/ParameterDescription.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 Direct3D9\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Describes a parameter used by an effect.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>D3DXPARAMETER_DESC</unmanaged>\r
  34                 public value class ParameterDescription : System::IEquatable<ParameterDescription>\r
  35                 {\r
  36                 public:\r
  37                         /// <summary>\r
  38                         /// Name of the parameter.\r
  39                         /// </summary>\r
  40                         property System::String^ Name;\r
  41 \r
  42                         /// <summary>\r
  43                         /// Semantic meaning of the parameter.\r
  44                         /// </summary>\r
  45             property System::String^ Semantic;\r
  46 \r
  47                         /// <summary>\r
  48                         /// The parameter class.\r
  49                         /// </summary>\r
  50             property ParameterClass Class;\r
  51 \r
  52                         /// <summary>\r
  53                         /// The parameter type.\r
  54                         /// </summary>\r
  55             property ParameterType Type;\r
  56 \r
  57                         /// <summary>\r
  58                         /// Number of rows in the array.\r
  59                         /// </summary>\r
  60             property int Rows;\r
  61 \r
  62                         /// <summary>\r
  63                         /// Number of columns in the array.\r
  64                         /// </summary>\r
  65             property int Columns;\r
  66 \r
  67                         /// <summary>\r
  68                         /// Number of elements in the array.\r
  69                         /// </summary>\r
  70             property int Elements;\r
  71 \r
  72                         /// <summary>\r
  73                         /// Number of annotations applied to the parameter.\r
  74                         /// </summary>\r
  75             property int Annotations;\r
  76 \r
  77                         /// <summary>\r
  78                         /// Number of structure members.\r
  79                         /// </summary>\r
  80             property int StructMembers;\r
  81 \r
  82                         /// <summary>\r
  83                         /// Flags describing the attributes of the parameter.\r
  84                         /// </summary>\r
  85             property ParameterFlags Flags;\r
  86 \r
  87                         /// <summary>\r
  88                         /// The size of the parameter, in bytes.\r
  89                         /// </summary>\r
  90             property int Bytes;\r
  91 \r
  92                         /// <summary>\r
  93                         /// Tests for equality between two objects.\r
  94                         /// </summary>\r
  95                         /// <param name="left">The first value to compare.</param>\r
  96                         /// <param name="right">The second value to compare.</param>\r
  97                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  98                         static bool operator == ( ParameterDescription left, ParameterDescription right );\r
  99 \r
 100                         /// <summary>\r
 101                         /// Tests for inequality between two objects.\r
 102                         /// </summary>\r
 103                         /// <param name="left">The first value to compare.</param>\r
 104                         /// <param name="right">The second value to compare.</param>\r
 105                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 106                         static bool operator != ( ParameterDescription left, ParameterDescription right );\r
 107 \r
 108                         /// <summary>\r
 109                         /// Returns the hash code for this instance.\r
 110                         /// </summary>\r
 111                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 112                         virtual int GetHashCode() override;\r
 113 \r
 114                         /// <summary>\r
 115                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 116                         /// </summary>\r
 117                         /// <param name="obj">Object to make the comparison with.</param>\r
 118                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 119                         virtual bool Equals( System::Object^ obj ) override;\r
 120 \r
 121                         /// <summary>\r
 122                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 123                         /// </summary>\r
 124                         /// <param name="other">Object to make the comparison with.</param>\r
 125                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 126                         virtual bool Equals( ParameterDescription other );\r
 127 \r
 128                         /// <summary>\r
 129                         /// Determines whether the specified object instances are considered equal. \r
 130                         /// </summary>\r
 131                         /// <param name="value1">The first value to compare.</param>\r
 132                         /// <param name="value2">The second value to compare.</param>\r
 133                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 134                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 135                         static bool Equals( ParameterDescription% value1, ParameterDescription% value2 );\r
 136                 };\r
 137         }\r
 138 }