SlimDXc_Jun2010(VC++2008)/source/direct3d11/EffectRenderTargetViewVariable11.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 "EffectVariable11.h"\r
  25 #include "RenderTargetView11.h"\r
  26 \r
  27 namespace SlimDX\r
  28 {\r
  29         namespace Direct3D11\r
  30         {\r
  31                 /// <summary>\r
  32                 /// Represents a render target view effect variable.\r
  33                 /// </summary>\r
  34                 /// <unmanaged>ID3DX11EffectRenderTargetViewVariable</unmanaged>\r
  35                 public ref class EffectRenderTargetViewVariable : public EffectVariable\r
  36                 {\r
  37                 private:\r
  38                         ID3DX11EffectRenderTargetViewVariable* m_Pointer;\r
  39                         \r
  40                 internal:\r
  41                         EffectRenderTargetViewVariable( ID3DX11EffectRenderTargetViewVariable* pointer );\r
  42                         \r
  43                 public:\r
  44                         /// <summary>\r
  45                         /// Initializes a new instance of the <see cref="EffectRenderTargetViewVariable"/> class.\r
  46                         /// </summary>\r
  47                         /// <param name="pointer">A pointer to the unmanaged interface.</param>\r
  48                         EffectRenderTargetViewVariable( System::IntPtr pointer );\r
  49 \r
  50                         /// <summary>\r
  51                         /// Gets the value of the variable.\r
  52                         /// </summary>\r
  53                         /// <returns>The view of the render target variable.</returns>\r
  54                         RenderTargetView^ GetView();\r
  55 \r
  56                         /// <summary>\r
  57                         /// Gets an array of views of render target surfaces from the variable.\r
  58                         /// </summary>\r
  59                         /// <param name="views">An array of views to hold the retrieved values.</param>\r
  60                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  61                         Result GetViewArray(array<RenderTargetView^>^ views);\r
  62 \r
  63                         /// <summary>\r
  64                         /// Gets an array of views of render target surfaces from the variable.\r
  65                         /// </summary>\r
  66                         /// <param name="views">An array of views to hold the retrieved values.</param>\r
  67                         /// <param name="offset">The offset into the array to begin storing values.</param>\r
  68                         /// <param name="count">The number of values to get.</param>\r
  69                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  70                         Result GetViewArray(array<RenderTargetView^>^ views, int offset, int count);\r
  71                         \r
  72                         /// <summary>\r
  73                         /// Sets the value of the variable.\r
  74                         /// </summary>\r
  75                         /// <param name="view">The view of the render target surface to set.</param>\r
  76                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  77                         Result SetView( RenderTargetView^ view );\r
  78 \r
  79                         /// <summary>\r
  80                         /// Sets the value of the variable.\r
  81                         /// </summary>\r
  82                         /// <param name="views">An array of views to set.</param>\r
  83                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  84                         Result SetViewArray(array<RenderTargetView^>^ views);\r
  85 \r
  86                         /// <summary>\r
  87                         /// Sets the value of the variable.\r
  88                         /// </summary>\r
  89                         /// <param name="views">An array of views to set.</param>\r
  90                         /// <param name="offset">The offset into the array to begin setting values.</param>\r
  91                         /// <param name="count">The number of values to set.</param>\r
  92                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  93                         Result SetViewArray(array<RenderTargetView^>^ views, int offset, int count);\r
  94                 };\r
  95         }\r
  96 };