SlimDXc_Jun2010(VC++2008)/source/d3dcompiler/ShaderTypeDescriptionDC.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 "EnumsDC.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace D3DCompiler\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Describes a shader-variable type.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>D3D11_SHADER_TYPE_DESC</unmanaged>\r
  34                 public value class ShaderTypeDescription : System::IEquatable<ShaderTypeDescription>\r
  35                 {\r
  36                 private:\r
  37                         ShaderVariableClass m_Class;\r
  38                         ShaderVariableType m_Type;\r
  39                         int m_Rows;\r
  40                         int m_Columns;\r
  41                         int m_Elements;\r
  42                         int m_Members;\r
  43                         int m_Offset;\r
  44 \r
  45                 internal:\r
  46                         ShaderTypeDescription( const D3D11_SHADER_TYPE_DESC& native );\r
  47                         \r
  48                 public:\r
  49                         /// <summary>\r
  50                         /// Identifies the variable class as one of scalar, vector, matrix or object.\r
  51                         /// </summary>\r
  52                         property ShaderVariableClass Class\r
  53                         {\r
  54                                 ShaderVariableClass get();\r
  55                         }\r
  56                         \r
  57                         /// <summary>\r
  58                         /// The variable type.\r
  59                         /// </summary>\r
  60                         property ShaderVariableType Type\r
  61                         {\r
  62                                 ShaderVariableType get();\r
  63                         }\r
  64                         \r
  65                         /// <summary>\r
  66                         /// Number of rows in a matrix. Otherwise a numeric type returns 1, any other type returns 0.\r
  67                         /// </summary>\r
  68                         property int Rows\r
  69                         {\r
  70                                 int get();\r
  71                         }\r
  72                         \r
  73                         /// <summary>\r
  74                         /// Number of columns in a matrix. Otherwise a numeric type returns 1, any other type returns 0.\r
  75                         /// </summary>\r
  76                         property int Columns\r
  77                         {\r
  78                                 int get();\r
  79                         }\r
  80 \r
  81                         /// <summary>\r
  82                         /// Number of elements in an array; otherwise 0.\r
  83                         /// </summary>\r
  84                         property int Elements\r
  85                         {\r
  86                                 int get();\r
  87                         }\r
  88                         \r
  89                         /// <summary>\r
  90                         /// Number of members in the structure; otherwise 0.\r
  91                         /// </summary>\r
  92                         property int Members\r
  93                         {\r
  94                                 int get();\r
  95                         }\r
  96                         \r
  97                         /// <summary>\r
  98                         /// Offset, in bytes, between the start of the parent structure and this variable.\r
  99                         /// </summary>\r
 100                         property int Offset\r
 101                         {\r
 102                                 int get();\r
 103                         }\r
 104 \r
 105                         /// <summary>\r
 106                         /// Tests for equality between two objects.\r
 107                         /// </summary>\r
 108                         /// <param name="left">The first value to compare.</param>\r
 109                         /// <param name="right">The second value to compare.</param>\r
 110                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 111                         static bool operator == ( ShaderTypeDescription left, ShaderTypeDescription right );\r
 112 \r
 113                         /// <summary>\r
 114                         /// Tests for inequality between two objects.\r
 115                         /// </summary>\r
 116                         /// <param name="left">The first value to compare.</param>\r
 117                         /// <param name="right">The second value to compare.</param>\r
 118                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 119                         static bool operator != ( ShaderTypeDescription left, ShaderTypeDescription right );\r
 120 \r
 121                         /// <summary>\r
 122                         /// Returns the hash code for this instance.\r
 123                         /// </summary>\r
 124                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 125                         virtual int GetHashCode() override;\r
 126 \r
 127                         /// <summary>\r
 128                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 129                         /// </summary>\r
 130                         /// <param name="obj">Object to make the comparison with.</param>\r
 131                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 132                         virtual bool Equals( System::Object^ obj ) override;\r
 133 \r
 134                         /// <summary>\r
 135                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 136                         /// </summary>\r
 137                         /// <param name="other">Object to make the comparison with.</param>\r
 138                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 139                         virtual bool Equals( ShaderTypeDescription other );\r
 140 \r
 141                         /// <summary>\r
 142                         /// Determines whether the specified object instances are considered equal. \r
 143                         /// </summary>\r
 144                         /// <param name="value1">The first value to compare.</param>\r
 145                         /// <param name="value2">The second value to compare.</param>\r
 146                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 147                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 148                         static bool Equals( ShaderTypeDescription% value1, ShaderTypeDescription% value2 );\r
 149                 };\r
 150         }\r
 151 };