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