SlimDXc_Jun2010(VC++2008)/source/direct3d10/VertexBufferBinding.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 namespace SlimDX
  25 {
  26         namespace Direct3D10
  27         {
  28                 ref class Buffer;
  29
  30                 /// <summary>
  31                 /// Properties defining the way a buffer (containing vertex data) is bound
  32                 /// to the pipeline for rendering.
  33                 /// </summary>
  34                 public value class VertexBufferBinding : System::IEquatable<VertexBufferBinding>
  35                 {
  36                 private:
  37                         Buffer^ m_Buffer;
  38                         int m_Stride;
  39                         int m_Offset;
  40
  41                 public:
  42                         /// <summary>
  43                         /// Gets or sets the buffer being bound.
  44                         /// </summary>
  45                         property Direct3D10::Buffer^ Buffer
  46                         {
  47                                 Direct3D10::Buffer^ get();
  48                                 void set( Direct3D10::Buffer^ value );
  49                         }
  50
  51                         /// <summary>
  52                         /// Gets or sets the stride between vertex elements in the buffer (in bytes).
  53                         /// </summary>
  54                         property int Stride
  55                         {
  56                                 int get();
  57                                 void set( int value );
  58                         }
  59
  60                         /// <summary>
  61                         /// Gets or sets the offset from the start of the buffer of the first vertex to use (in bytes).
  62                         /// </summary>
  63                         property int Offset
  64                         {
  65                                 int get();
  66                                 void set( int value );
  67                         }
  68
  69                         /// <summary>
  70                         /// Constructs a new VertexBufferBinding object.
  71                         /// </summary>
  72                         /// <param name="buffer">The buffer being bound.</param>
  73                         /// <param name="stride">The stride between vertex element (in bytes).</param>
  74                         /// <param name="offset">The offset to the first vertex (in bytes).</param>
  75                         VertexBufferBinding( Direct3D10::Buffer^ buffer, int stride, int offset );
  76
  77                         /// <summary>
  78                         /// Tests for equality between two VertexBufferBindings.
  79                         /// </summary>
  80                         /// <param name="left">The first value to compare.</param>
  81                         /// <param name="right">The second value to compare.</param>
  82                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  83                         static bool operator == ( VertexBufferBinding left, VertexBufferBinding right );
  84
  85                         /// <summary>
  86                         /// Tests for inequality between two VertexBufferBindings.
  87                         /// </summary>
  88                         /// <param name="left">The first value to compare.</param>
  89                         /// <param name="right">The second value to compare.</param>
  90                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  91                         static bool operator != ( VertexBufferBinding left, VertexBufferBinding right );
  92
  93                         /// <summary>
  94                         /// Returns the hash code for this instance.
  95                         /// </summary>
  96                         /// <returns>A 32-bit signed integer hash code.</returns>
  97                         virtual int GetHashCode() override;
  98
  99                         /// <summary>
 100                         /// Returns a value indicating whether this instance is equal to the specified object.
 101                         /// </summary>
 102                         /// <param name="obj">An object to compare with this instance.</param>
 103                         /// <returns><c>true</c> if <paramref name="obj"/> has the same value as this instance; otherwise, <c>false</c>.</returns>
 104                         virtual bool Equals( System::Object^ obj ) override;
 105
 106                         /// <summary>
 107                         /// Returns a value indicating whether this instance is equal to the specified object.
 108                         /// </summary>
 109                         /// <param name="other">A <see cref="SlimDX::Direct3D10::VertexBufferBinding"/> to compare with this instance.</param>
 110                         /// <returns><c>true</c> if <paramref name="other"/> has the same value as this instance; otherwise, <c>false</c>.</returns>
 111                         virtual bool Equals( VertexBufferBinding other );
 112
 113                         /// <summary>
 114                         /// Returns a value indicating whether the two VertexBufferBindings are equivalent.
 115                         /// </summary>
 116                         /// <param name="value1">The first value to compare.</param>
 117                         /// <param name="value2">The second value to compare.</param>
 118                         /// <returns><c>true</c> if <paramref name="value1"/> has the same value as <paramref name="value2"/>; otherwise, <c>false</c>.</returns>
 119                         static bool Equals( VertexBufferBinding% value1, VertexBufferBinding% value2 );
 120                 };
 121         }
 122 };