SlimDXc_Jun2010(VC++2008)/source/direct3d11/StreamOutputBufferBinding11.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 namespace SlimDX\r
  25 {\r
  26         namespace Direct3D11\r
  27         {\r
  28                 ref class Buffer;\r
  29                 \r
  30                 /// <summary>\r
  31                 /// Properties defining the way a buffer is bound to the pipeline as a target for stream output operations.\r
  32                 /// </summary>\r
  33                 public value class StreamOutputBufferBinding : System::IEquatable<StreamOutputBufferBinding>\r
  34                 {\r
  35                 private:\r
  36                         Buffer^ m_Buffer;\r
  37                         int m_Offset;\r
  38 \r
  39                 public:\r
  40                         /// <summary>\r
  41                         /// Gets or sets the buffer being bound.\r
  42                         /// </summary>\r
  43                         property SlimDX::Direct3D11::Buffer^ Buffer\r
  44                         {\r
  45                                 Direct3D11::Buffer^ get();\r
  46                                 void set( Direct3D11::Buffer^ value );\r
  47                         }\r
  48 \r
  49                         /// <summary>\r
  50                         /// Gets or sets the offset from the start of the buffer of the first vertex to use (in bytes).\r
  51                         /// </summary>\r
  52                         property int Offset\r
  53                         {\r
  54                                 int get();\r
  55                                 void set( int value );\r
  56                         }\r
  57 \r
  58                         /// <summary>\r
  59                         /// Initializes a new instance of the <see cref="StreamOutputBufferBinding"/> struct.\r
  60                         /// </summary>\r
  61                         /// <param name="buffer">The buffer being bound.</param>\r
  62                         /// <param name="offset">The offset to the first vertex (in bytes).</param>\r
  63                         StreamOutputBufferBinding( Direct3D11::Buffer^ buffer, int offset );\r
  64 \r
  65                         /// <summary>\r
  66                         /// Tests for equality between two objects.\r
  67                         /// </summary>\r
  68                         /// <param name="left">The first value to compare.</param>\r
  69                         /// <param name="right">The second value to compare.</param>\r
  70                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  71                         static bool operator == ( StreamOutputBufferBinding left, StreamOutputBufferBinding right );\r
  72 \r
  73                         /// <summary>\r
  74                         /// Tests for inequality between two objects.\r
  75                         /// </summary>\r
  76                         /// <param name="left">The first value to compare.</param>\r
  77                         /// <param name="right">The second value to compare.</param>\r
  78                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  79                         static bool operator != ( StreamOutputBufferBinding left, StreamOutputBufferBinding right );\r
  80 \r
  81                         /// <summary>\r
  82                         /// Returns the hash code for this instance.\r
  83                         /// </summary>\r
  84                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  85                         virtual int GetHashCode() override;\r
  86 \r
  87                         /// <summary>\r
  88                         /// Returns a value indicating whether this instance is equal to the specified object.\r
  89                         /// </summary>\r
  90                         /// <param name="obj">An object to compare with this instance.</param>\r
  91                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
  92                         virtual bool Equals( System::Object^ obj ) override;\r
  93 \r
  94                         /// <summary>\r
  95                         /// Returns a value indicating whether this instance is equal to the specified object.\r
  96                         /// </summary>\r
  97                         /// <param name="other">A <see cref="SlimDX::Direct3D11::StreamOutputBufferBinding"/> to compare with this instance.</param>\r
  98                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>\r
  99                         virtual bool Equals( StreamOutputBufferBinding other );\r
 100 \r
 101                         /// <summary>\r
 102                         /// Returns a value indicating whether the two objects are equivalent.\r
 103                         /// </summary>\r
 104                         /// <param name="value1">The first value to compare.</param>\r
 105                         /// <param name="value2">The second value to compare.</param>\r
 106                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>\r
 107                         static bool Equals( StreamOutputBufferBinding% value1, StreamOutputBufferBinding% value2 );\r
 108                 };\r
 109         }\r
 110 };