110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/direct3d11/EffectVariableDescription11.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 "Enums11.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace Direct3D11\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Provides a description for effect variables.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>D3DX11_EFFECT_VARIABLE_DESC</unmanaged>\r
  34                 public value class EffectVariableDescription : System::IEquatable<EffectVariableDescription>\r
  35                 {\r
  36                 private:\r
  37                         System::String^ m_Name;\r
  38                         System::String^ m_Semantic;\r
  39                         EffectVariableFlags m_Flags;\r
  40                         int m_Annotations;\r
  41                         int m_BufferOffset;\r
  42                         int m_ExplicitBindPoint;\r
  43 \r
  44                 internal:\r
  45                         EffectVariableDescription( const D3DX11_EFFECT_VARIABLE_DESC& native );\r
  46                         \r
  47                 public:\r
  48                         /// <summary>\r
  49                         /// Name of this variable, annotation, or structure member.\r
  50                         /// </summary>\r
  51                         property System::String^ Name\r
  52                         {\r
  53                                 System::String^ get();\r
  54                         }\r
  55                         \r
  56                         /// <summary>\r
  57                         /// Semantic string of this variable or structure member.\r
  58                         /// </summary>\r
  59                         property System::String^ Semantic\r
  60                         {\r
  61                                 System::String^ get();\r
  62                         }\r
  63                         \r
  64                         /// <summary>\r
  65                         /// Optional flags for effect variables.\r
  66                         /// </summary>\r
  67                         property EffectVariableFlags Flags\r
  68                         {\r
  69                                 EffectVariableFlags get();\r
  70                         }\r
  71                         \r
  72                         /// <summary>\r
  73                         /// Number of annotations on this variable.\r
  74                         /// </summary>\r
  75                         property int AnnotationCount\r
  76                         {\r
  77                                 int get();\r
  78                         }\r
  79                         \r
  80                         /// <summary>\r
  81                         /// Offset into containing cbuffer or tbuffer (always 0 for annotations or variables not in constant buffers).\r
  82                         /// </summary>\r
  83                         property int ConstantBufferOffset\r
  84                         {\r
  85                                 int get();\r
  86                         }\r
  87                         \r
  88                         /// <summary>\r
  89                         /// Used if the variable has been explicitly bound using the register keyword.\r
  90                         /// </summary>\r
  91                         property int ExplicitBindPoint\r
  92                         {\r
  93                                 int get();\r
  94                         }\r
  95 \r
  96                         /// <summary>\r
  97                         /// Tests for equality between two objects.\r
  98                         /// </summary>\r
  99                         /// <param name="left">The first value to compare.</param>\r
 100                         /// <param name="right">The second value to compare.</param>\r
 101                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 102                         static bool operator == ( EffectVariableDescription left, EffectVariableDescription right );\r
 103 \r
 104                         /// <summary>\r
 105                         /// Tests for inequality between two objects.\r
 106                         /// </summary>\r
 107                         /// <param name="left">The first value to compare.</param>\r
 108                         /// <param name="right">The second value to compare.</param>\r
 109                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 110                         static bool operator != ( EffectVariableDescription left, EffectVariableDescription right );\r
 111 \r
 112                         /// <summary>\r
 113                         /// Returns the hash code for this instance.\r
 114                         /// </summary>\r
 115                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 116                         virtual int GetHashCode() override;\r
 117 \r
 118                         /// <summary>\r
 119                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 120                         /// </summary>\r
 121                         /// <param name="obj">Object to make the comparison with.</param>\r
 122                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 123                         virtual bool Equals( System::Object^ obj ) override;\r
 124 \r
 125                         /// <summary>\r
 126                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 127                         /// </summary>\r
 128                         /// <param name="other">Object to make the comparison with.</param>\r
 129                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 130                         virtual bool Equals( EffectVariableDescription other );\r
 131 \r
 132                         /// <summary>\r
 133                         /// Determines whether the specified object instances are considered equal. \r
 134                         /// </summary>\r
 135                         /// <param name="value1">The first value to compare.</param>\r
 136                         /// <param name="value2">The second value to compare.</param>\r
 137                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 138                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 139                         static bool Equals( EffectVariableDescription% value1, EffectVariableDescription% value2 );\r
 140                 };\r
 141         }\r
 142 };