SlimDXc_Jun2010(VC++2008)/source/direct3d10/EffectVariable.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 "../ComObject.h"\r
  25 \r
  26 #include "Enums.h"\r
  27 \r
  28 namespace SlimDX\r
  29 {\r
  30         namespace Direct3D10\r
  31         {\r
  32                 ref class EffectConstantBuffer;\r
  33                 ref class EffectMatrixVariable;\r
  34                 ref class EffectResourceVariable;\r
  35                 ref class EffectShaderVariable;\r
  36                 ref class EffectScalarVariable;\r
  37                 ref class EffectVectorVariable;\r
  38                 ref class EffectStringVariable;\r
  39                 value class EffectVariableDescription;\r
  40                 \r
  41                 public ref class EffectVariable\r
  42                 {\r
  43                 private:\r
  44                         ID3D10EffectVariable* m_Pointer;\r
  45                         \r
  46                 internal:\r
  47                         EffectVariable( ID3D10EffectVariable* pointer );\r
  48 \r
  49                 public:\r
  50                         property EffectVariableDescription Description\r
  51                         {\r
  52                                 EffectVariableDescription get();\r
  53                         }\r
  54                         \r
  55                         property bool IsValid\r
  56                         {\r
  57                                 bool get();\r
  58                         }\r
  59                         \r
  60                         EffectVariable( System::IntPtr pointer );\r
  61                         \r
  62                         EffectVariable^ GetAnnotationByIndex( int index );\r
  63                         EffectVariable^ GetAnnotationByName( System::String^ name );\r
  64                         \r
  65                         EffectVariable^ GetElement( int index );\r
  66                         \r
  67                         EffectVariable^ GetMemberByIndex( int index );\r
  68                         EffectVariable^ GetMemberByName( System::String^ name );\r
  69                         EffectVariable^ GetMemberBySemantic( System::String^ name );\r
  70                         \r
  71                         EffectConstantBuffer^ AsConstantBuffer();\r
  72                         EffectMatrixVariable^ AsMatrix();\r
  73                         EffectResourceVariable^ AsResource();\r
  74                         EffectShaderVariable^ AsShader();\r
  75                         EffectScalarVariable^ AsScalar();\r
  76                         EffectVectorVariable^ AsVector();\r
  77                         EffectStringVariable^ AsString();\r
  78 \r
  79                         /// <summary>\r
  80                         /// Sets the value of the variable using raw bytes.\r
  81                         /// </summary>\r
  82                         /// <param name="count">The number of bytes to set.</param>\r
  83                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  84                         Result SetRawValue(DataStream^ data, int count);\r
  85 \r
  86                         /// <summary>\r
  87                         /// Gets the value of the variable in raw bytes.\r
  88                         /// </summary>\r
  89                         /// <param name="count">The number of bytes to retrieve.</param>\r
  90                         /// <returns>The raw data representing the value of the variable.</returns>\r
  91                         DataStream^ GetRawValue(int count);\r
  92                 };\r
  93         }\r
  94 };