SlimDXc_Jun2010(VC++2008)/source/direct3d11/DepthStencilViewDescription11.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 "../dxgi/Enums.h"\r
  25 \r
  26 #include "Enums11.h"\r
  27 \r
  28 namespace SlimDX\r
  29 {\r
  30         namespace Direct3D11\r
  31         {\r
  32                 /// <summary>\r
  33                 /// Specifies the subresources of a texture that are accessible from a depth-stencil view.\r
  34                 /// </summary>\r
  35                 /// <unmanaged>D3D11_DEPTH_STENCIL_VIEW_DESC</unmanaged>\r
  36                 public value class DepthStencilViewDescription : System::IEquatable<DepthStencilViewDescription>\r
  37                 {                               \r
  38                 internal:\r
  39                         DepthStencilViewDescription( const D3D11_DEPTH_STENCIL_VIEW_DESC& native );\r
  40                         \r
  41                         D3D11_DEPTH_STENCIL_VIEW_DESC CreateNativeVersion();\r
  42                 \r
  43                 public:\r
  44                         /// <summary>\r
  45                         /// Resource data format.\r
  46                         /// </summary>\r
  47                         property DXGI::Format Format;\r
  48 \r
  49                         /// <summary>\r
  50                         /// Type of resource. Specifies how a depth-stencil resource will be accessed.\r
  51                         /// </summary>\r
  52                         property DepthStencilViewDimension Dimension;\r
  53 \r
  54                         /// <summary>\r
  55                         /// A value that describes whether the texture is read only.\r
  56                         /// </summary>\r
  57                         property DepthStencilViewFlags Flags;\r
  58 \r
  59                         /// <summary>\r
  60                         /// The index of the first mipmap level to use.\r
  61                         /// </summary>\r
  62                         property int MipSlice;\r
  63 \r
  64                         /// <summary>\r
  65                         /// The index of the first texture to use in an array of textures.\r
  66                         /// </summary>\r
  67                         property int FirstArraySlice;\r
  68 \r
  69                         /// <summary>\r
  70                         /// Number of textures to use.\r
  71                         /// </summary>\r
  72                         property int ArraySize;\r
  73 \r
  74                         /// <summary>\r
  75                         /// Tests for equality between two objects.\r
  76                         /// </summary>\r
  77                         /// <param name="left">The first value to compare.</param>\r
  78                         /// <param name="right">The second value to compare.</param>\r
  79                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  80                         static bool operator == ( DepthStencilViewDescription left, DepthStencilViewDescription right );\r
  81 \r
  82                         /// <summary>\r
  83                         /// Tests for inequality between two objects.\r
  84                         /// </summary>\r
  85                         /// <param name="left">The first value to compare.</param>\r
  86                         /// <param name="right">The second value to compare.</param>\r
  87                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  88                         static bool operator != ( DepthStencilViewDescription left, DepthStencilViewDescription right );\r
  89 \r
  90                         /// <summary>\r
  91                         /// Returns the hash code for this instance.\r
  92                         /// </summary>\r
  93                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  94                         virtual int GetHashCode() override;\r
  95 \r
  96                         /// <summary>\r
  97                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  98                         /// </summary>\r
  99                         /// <param name="obj">Object to make the comparison with.</param>\r
 100                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 101                         virtual bool Equals( System::Object^ obj ) override;\r
 102 \r
 103                         /// <summary>\r
 104                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 105                         /// </summary>\r
 106                         /// <param name="other">Object to make the comparison with.</param>\r
 107                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 108                         virtual bool Equals( DepthStencilViewDescription other );\r
 109 \r
 110                         /// <summary>\r
 111                         /// Determines whether the specified object instances are considered equal. \r
 112                         /// </summary>\r
 113                         /// <param name="value1">The first value to compare.</param>\r
 114                         /// <param name="value2">The second value to compare.</param>\r
 115                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 116                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 117                         static bool Equals( DepthStencilViewDescription% value1, DepthStencilViewDescription% value2 );\r
 118                 };\r
 119         }\r
 120 };