SlimDXc_Jun2010(VC++2008)/source/directsound/CaptureBufferDescription.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 "../multimedia/WaveFormat.h"\r
  25 #include "CaptureEffectDescription.h"\r
  26 \r
  27 namespace SlimDX\r
  28 {\r
  29         namespace DirectSound\r
  30         {\r
  31                 /// <summary>\r
  32                 /// Describes a capture buffer.\r
  33                 /// </summary>\r
  34                 /// <unmanaged>DSCBUFFERDESC</unmanaged>\r
  35                 public value class CaptureBufferDescription : System::IEquatable<CaptureBufferDescription>\r
  36                 {\r
  37                 internal:\r
  38                         DSCBUFFERDESC ToUnmanaged();\r
  39 \r
  40                 public:\r
  41                         /// <summary>\r
  42                         /// Size of capture buffer to create, in bytes.\r
  43                         /// </summary>\r
  44                         property int BufferBytes;\r
  45 \r
  46                         /// <summary>\r
  47                         /// The buffer supports effects.\r
  48                         /// </summary>\r
  49                         property bool ControlEffects;\r
  50 \r
  51                         /// <summary>\r
  52                         /// The Win32 wave mapper will be used for formats not supported by the device.\r
  53                         /// </summary>\r
  54                         property bool WaveMapped;\r
  55 \r
  56                         /// <summary>\r
  57                         /// The format in which to capture the data.\r
  58                         /// </summary>\r
  59                         property SlimDX::Multimedia::WaveFormat^ Format;\r
  60 \r
  61                         /// <summary>\r
  62                         /// Describes effects supported by hardware for the buffer.\r
  63                         /// </summary>\r
  64                         property array<CaptureEffectDescription>^ EffectDescriptions;\r
  65 \r
  66                         /// <summary>\r
  67                         /// Tests for equality between two objects.\r
  68                         /// </summary>\r
  69                         /// <param name="left">The first value to compare.</param>\r
  70                         /// <param name="right">The second value to compare.</param>\r
  71                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  72                         static bool operator == ( CaptureBufferDescription left, CaptureBufferDescription right );\r
  73 \r
  74                         /// <summary>\r
  75                         /// Tests for inequality 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 a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  80                         static bool operator != ( CaptureBufferDescription left, CaptureBufferDescription right );\r
  81 \r
  82                         /// <summary>\r
  83                         /// Returns the hash code for this instance.\r
  84                         /// </summary>\r
  85                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  86                         virtual int GetHashCode() override;\r
  87 \r
  88                         /// <summary>\r
  89                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  90                         /// </summary>\r
  91                         /// <param name="obj">Object to make the comparison with.</param>\r
  92                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  93                         virtual bool Equals( System::Object^ obj ) override;\r
  94 \r
  95                         /// <summary>\r
  96                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
  97                         /// </summary>\r
  98                         /// <param name="other">Object to make the comparison with.</param>\r
  99                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 100                         virtual bool Equals( CaptureBufferDescription other );\r
 101 \r
 102                         /// <summary>\r
 103                         /// Determines whether the specified object instances are considered equal. \r
 104                         /// </summary>\r
 105                         /// <param name="value1">The first value to compare.</param>\r
 106                         /// <param name="value2">The second value to compare.</param>\r
 107                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 108                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 109                         static bool Equals( CaptureBufferDescription% value1, CaptureBufferDescription% value2 );       \r
 110                 };\r
 111         }\r
 112 }