SlimDXc_Jun2010(VC++2008)/source/directsound/BufferCapabilities.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 DirectSound\r
  27         {\r
  28 #ifdef XMLDOCS\r
  29                 ref class SoundBuffer;\r
  30 #endif\r
  31 \r
  32                 /// <summary>\r
  33                 /// Describes the capabilities of a DirectSound buffer object.\r
  34                 /// </summary>\r
  35                 /// <unmanaged>DSBCAPS</unmanaged>\r
  36                 public value class BufferCapabilities : System::IEquatable<BufferCapabilities>\r
  37                 {\r
  38                 internal:\r
  39                         BufferCapabilities( const DSBCAPS &caps );\r
  40 \r
  41                 public:\r
  42                         /// <summary>\r
  43                         /// Size of this buffer, in bytes.\r
  44                         /// </summary>\r
  45                         property int BufferSize;\r
  46 \r
  47                         /// <summary>\r
  48                         /// The rate, in kilobytes per second, at which data is transferred to the buffer memory when <see cref="SlimDX::DirectSound::SoundBuffer">SoundBuffer.Unlock</see> is called.\r
  49                         /// </summary>\r
  50                         property int UnlockTransferRate;\r
  51 \r
  52                         /// <summary>\r
  53                         /// The processing overhead as a percentage of main processor cycles needed to mix this sound buffer.\r
  54                         /// </summary>\r
  55                         property int PlayCpuOverhead;\r
  56 \r
  57                         /// <summary>\r
  58                         /// Gets or Sets whether the buffer uses the new behavior of the play cursor when retrieving the current position.\r
  59                         /// </summary>\r
  60                         property bool CanGetCurrentPosition;\r
  61 \r
  62                         /// <summary>\r
  63                         /// Gets or Sets whether the buffer has 3D control capability.\r
  64                         /// </summary>\r
  65                         property bool Control3D;\r
  66 \r
  67                         /// <summary>\r
  68                         /// Gets or Sets whether the buffer has frequency control capability.\r
  69                         /// </summary>\r
  70                         property bool ControlFrequency;\r
  71 \r
  72                         /// <summary>\r
  73                         /// Gets or Sets whether the buffer has volume control capability.\r
  74                         /// </summary>\r
  75                         property bool ControlVolume;\r
  76 \r
  77                         /// <summary>\r
  78                         /// Gets or Sets whether the buffer has pan control capability.\r
  79                         /// </summary>\r
  80                         property bool ControlPan;\r
  81 \r
  82                         /// <summary>\r
  83                         /// Gets or Sets whether the buffer has position notification capability.\r
  84                         /// </summary>\r
  85                         property bool ControlPositionNotify;\r
  86 \r
  87                         /// <summary>\r
  88                         /// Gets or Sets whether the buffer supports effects processing.\r
  89                         /// </summary>\r
  90                         property bool ControlEffects;\r
  91 \r
  92                         /// <summary>\r
  93                         /// Gets or Sets whether the buffer is a global sound buffer.\r
  94                         /// </summary>\r
  95                         property bool GlobalFocus;\r
  96 \r
  97                         /// <summary>\r
  98                         /// Gets or Sets whether the buffer uses hardware mixing.\r
  99                         /// </summary>\r
 100                         property bool LocateInHardware;\r
 101 \r
 102                         /// <summary>\r
 103                         /// Gets or Sets whether the buffer is in software memory and uses software mixing.\r
 104                         /// </summary>\r
 105                         property bool LocateInSoftware;\r
 106 \r
 107                         /// <summary>\r
 108                         /// Gets or Sets whether the buffer can be assigned to a hardware or software resource at play time.\r
 109                         /// </summary>\r
 110                         property bool LocationDefer;\r
 111 \r
 112                         /// <summary>\r
 113                         /// Gets or Sets whether the sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted. Applies only to software buffers.\r
 114                         /// </summary>\r
 115                         property bool Mute3DAtMaximumDistance;\r
 116 \r
 117                         /// <summary>\r
 118                         /// Gets or Sets whether the buffer is a primary buffer.\r
 119                         /// </summary>\r
 120                         property bool PrimaryBuffer;\r
 121 \r
 122                         /// <summary>\r
 123                         /// Gets or Sets whether the buffer is in on-board hardware memory.\r
 124                         /// </summary>\r
 125                         property bool StaticBuffer;\r
 126 \r
 127                         /// <summary>\r
 128                         /// Gets or Sets whether the buffer has sticky focus.\r
 129                         /// </summary>\r
 130                         property bool StickyFocus;\r
 131 \r
 132                         /// <summary>\r
 133                         /// Tests for equality between two objects.\r
 134                         /// </summary>\r
 135                         /// <param name="left">The first value to compare.</param>\r
 136                         /// <param name="right">The second value to compare.</param>\r
 137                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 138                         static bool operator == ( BufferCapabilities left, BufferCapabilities right );\r
 139 \r
 140                         /// <summary>\r
 141                         /// Tests for inequality between two objects.\r
 142                         /// </summary>\r
 143                         /// <param name="left">The first value to compare.</param>\r
 144                         /// <param name="right">The second value to compare.</param>\r
 145                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
 146                         static bool operator != ( BufferCapabilities left, BufferCapabilities right );\r
 147 \r
 148                         /// <summary>\r
 149                         /// Returns the hash code for this instance.\r
 150                         /// </summary>\r
 151                         /// <returns>A 32-bit signed integer hash code.</returns>\r
 152                         virtual int GetHashCode() override;\r
 153 \r
 154                         /// <summary>\r
 155                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
 156                         /// </summary>\r
 157                         /// <param name="obj">Object to make the comparison with.</param>\r
 158                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 159                         virtual bool Equals( System::Object^ obj ) override;\r
 160 \r
 161                         /// <summary>\r
 162                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 163                         /// </summary>\r
 164                         /// <param name="other">Object to make the comparison with.</param>\r
 165                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 166                         virtual bool Equals( BufferCapabilities other );\r
 167 \r
 168                         /// <summary>\r
 169                         /// Determines whether the specified object instances are considered equal. \r
 170                         /// </summary>\r
 171                         /// <param name="value1">The first value to compare.</param>\r
 172                         /// <param name="value2">The second value to compare.</param>\r
 173                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 174                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 175                         static bool Equals( BufferCapabilities% value1, BufferCapabilities% value2 );   \r
 176                 };\r
 177         }\r
 178 }\r
 179