SlimDXc_Jun2010(VC++2008)/source/direct3d11/EffectType11.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 "Enums11.h"\r
  27 \r
  28 namespace SlimDX\r
  29 {\r
  30         namespace Direct3D11\r
  31         {\r
  32                 value class EffectTypeDescription;\r
  33 \r
  34                 /// <summary>\r
  35                 /// Represents the type of an effect variable.\r
  36                 /// </summary>\r
  37                 /// <unmanaged>ID3DX11EffectType</unmanaged>\r
  38                 public ref class EffectType\r
  39                 {\r
  40                 private:\r
  41                         ID3DX11EffectType* m_Pointer;\r
  42                         \r
  43                 internal:\r
  44                         EffectType( ID3DX11EffectType* pointer );\r
  45 \r
  46                 public:\r
  47                         /// <summary>\r
  48                         /// Gets the effect type's description.\r
  49                         /// </summary>\r
  50                         property EffectTypeDescription Description\r
  51                         {\r
  52                                 EffectTypeDescription get();\r
  53                         }\r
  54                         \r
  55                         /// <summary>\r
  56                         /// Indicates whether the type represents a valid interface.\r
  57                         /// </summary>\r
  58                         property bool IsValid\r
  59                         {\r
  60                                 bool get();\r
  61                         }\r
  62                         \r
  63                         /// <summary>\r
  64                         /// Initializes a new instance of the <see cref="EffectType"/> class.\r
  65                         /// </summary>\r
  66                         /// <param name="pointer">A pointer to the unmanaged interface.</param>\r
  67                         EffectType( System::IntPtr pointer );\r
  68 \r
  69                         /// <summary>\r
  70                         /// Get the name of a type member.\r
  71                         /// </summary>\r
  72                         /// <param name="index">The zero-based index of the structure member type to retrieve.</param>\r
  73                         /// <returns>The name of the specified member.</returns>\r
  74                         System::String^ GetMemberName( int index );\r
  75 \r
  76                         /// <summary>\r
  77                         /// Get the semantic of a type member.\r
  78                         /// </summary>\r
  79                         /// <param name="index">The zero-based index of the structure member type to retrieve.</param>\r
  80                         /// <returns>The semantic of the specified member.</returns>\r
  81                         System::String^ GetMemberSemantic( int index );\r
  82                         \r
  83                         /// <summary>\r
  84                         /// Get a structure member type by index.\r
  85                         /// </summary>\r
  86                         /// <param name="index">The zero-based index of the structure member type to retrieve.</param>\r
  87                         /// <returns>The structure member type at the specified index.</returns>\r
  88                         EffectType^ GetMemberTypeByIndex( int index );\r
  89 \r
  90                         /// <summary>\r
  91                         /// Get a structure member type by name.\r
  92                         /// </summary>\r
  93                         /// <param name="name">The name of the structure member type to retrieve.</param>\r
  94                         /// <returns>The structure member type with the given name.</returns>\r
  95                         EffectType^ GetMemberTypeByName( System::String^ name );\r
  96 \r
  97                         /// <summary>\r
  98                         /// Get a structure member type by semantic.\r
  99                         /// </summary>\r
 100                         /// <param name="name">The semantic of the structure member type to retrieve.</param>\r
 101                         /// <returns>The structure member type with the given semantic.</returns>\r
 102                         EffectType^ GetMemberTypeBySemantic( System::String^ name );\r
 103                 };\r
 104         }\r
 105 };