110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/direct3d11/EffectMatrixVariable11.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 "../math/Matrix.h"\r
  25 \r
  26 #include "EffectVariable11.h"\r
  27 \r
  28 using System::Runtime::InteropServices::OutAttribute;\r
  29 \r
  30 namespace SlimDX\r
  31 {\r
  32         namespace Direct3D11\r
  33         {\r
  34                 /// <summary>\r
  35                 /// Represents a matrix effect variable.\r
  36                 /// </summary>\r
  37                 /// <unmanaged>ID3DX11EffectMatrixVariable</unmanaged>\r
  38                 public ref class EffectMatrixVariable : public EffectVariable\r
  39                 {\r
  40                 private:\r
  41                         ID3DX11EffectMatrixVariable* m_Pointer;\r
  42                         \r
  43                 internal:\r
  44                         EffectMatrixVariable( ID3DX11EffectMatrixVariable* pointer );\r
  45 \r
  46                 public:\r
  47                         /// <summary>\r
  48                         /// Initializes a new instance of the <see cref="EffectMatrixVariable"/> class.\r
  49                         /// </summary>\r
  50                         /// <param name="pointer">A pointer to the unmanaged interface.</param>\r
  51                         EffectMatrixVariable( System::IntPtr pointer );\r
  52 \r
  53                         /// <summary>\r
  54                         /// Gets the value of the variable.\r
  55                         /// </summary>\r
  56                         /// <returns>The matrix value of the variable.</returns>\r
  57                         Matrix GetMatrix();\r
  58 \r
  59                         /// <summary>\r
  60                         /// Gets the value of the variable.\r
  61                         /// </summary>\r
  62                         /// <param name="result">When the method completes, contains the value of the variable.</param>\r
  63                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  64                         Result GetMatrix([Out] Matrix% result);\r
  65 \r
  66                         /// <summary>\r
  67                         /// Gets an array of matrix values from the variable.\r
  68                         /// </summary>\r
  69                         /// <param name="matrices">An array of matrices to hold the retrieved values.</param>\r
  70                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  71                         Result GetMatrixArray(array<Matrix>^ matrices);\r
  72 \r
  73                         /// <summary>\r
  74                         /// Gets an array of matrix values from the variable.\r
  75                         /// </summary>\r
  76                         /// <param name="matrices">An array of matrices to hold the retrieved values.</param>\r
  77                         /// <param name="offset">The offset into the array to begin storing values.</param>\r
  78                         /// <param name="count">The number of values to get.</param>\r
  79                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  80                         Result GetMatrixArray(array<Matrix>^ matrices, int offset, int count);\r
  81 \r
  82                         /// <summary>\r
  83                         /// Gets the transposed value of the variable.\r
  84                         /// </summary>\r
  85                         /// <returns>The transposed matrix value of the variable.</returns>\r
  86                         Matrix GetMatrixTranspose();\r
  87 \r
  88                         /// <summary>\r
  89                         /// Gets the transposed value of the variable.\r
  90                         /// </summary>\r
  91                         /// <param name="result">When the method completes, contains the transposed value of the variable.</param>\r
  92                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  93                         Result GetMatrixTranspose([Out] Matrix% result);\r
  94 \r
  95                         /// <summary>\r
  96                         /// Gets an array of transposed matrix values from the variable.\r
  97                         /// </summary>\r
  98                         /// <param name="matrices">An array of matrices to hold the retrieved transposed values.</param>\r
  99                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 100                         Result GetMatrixTransposeArray(array<Matrix>^ matrices);\r
 101 \r
 102                         /// <summary>\r
 103                         /// Gets an array of transposed matrix values from the variable.\r
 104                         /// </summary>\r
 105                         /// <param name="matrices">An array of matrices to hold the retrieved transposed values.</param>\r
 106                         /// <param name="offset">The offset into the array to begin storing values.</param>\r
 107                         /// <param name="count">The number of values to get.</param>\r
 108                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 109                         Result GetMatrixTransposeArray(array<Matrix>^ matrices, int offset, int count);\r
 110                         \r
 111                         /// <summary>\r
 112                         /// Sets the value of the variable.\r
 113                         /// </summary>\r
 114                         /// <param name="matrix">The matrix value to set.</param>\r
 115                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 116                         Result SetMatrix( Matrix matrix );\r
 117 \r
 118                         /// <summary>\r
 119                         /// Sets the value of the variable.\r
 120                         /// </summary>\r
 121                         /// <param name="matrices">An array of matrices to set.</param>\r
 122                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 123                         Result SetMatrixArray( array<Matrix>^ matrices );\r
 124 \r
 125                         /// <summary>\r
 126                         /// Sets the value of the variable.\r
 127                         /// </summary>\r
 128                         /// <param name="matrices">An array of matrices to set.</param>\r
 129                         /// <param name="offset">The offset into the array to begin setting values.</param>\r
 130                         /// <param name="count">The number of values to set.</param>\r
 131                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 132                         Result SetMatrixArray( array<Matrix>^ matrices, int offset, int count );\r
 133 \r
 134                         /// <summary>\r
 135                         /// Transposes and sets the matrix value of the variable.\r
 136                         /// </summary>\r
 137                         /// <param name="matrix">The matrix value to transpose and set.</param>\r
 138                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 139                         Result SetMatrixTranspose( Matrix matrix );\r
 140 \r
 141                         /// <summary>\r
 142                         /// Transposes and sets the matrix value of the variable.\r
 143                         /// </summary>\r
 144                         /// <param name="matrices">An array of matrices to transpose and set.</param>\r
 145                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 146                         Result SetMatrixTransposeArray( array<Matrix>^ matrices );\r
 147 \r
 148                         /// <summary>\r
 149                         /// Transposes and sets the matrix value of the variable.\r
 150                         /// </summary>\r
 151                         /// <param name="matrices">An array of matrices to transpose and set.</param>\r
 152                         /// <param name="offset">The offset into the array to begin setting values.</param>\r
 153                         /// <param name="count">The number of values to set.</param>\r
 154                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
 155                         Result SetMatrixTransposeArray( array<Matrix>^ matrices, int offset, int count );\r
 156                 };\r
 157         }\r
 158 };