SlimDXc_Jun2010(VC++2008)/source/direct3d9/PresentParameters.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 #include "Enums.h"
  25
  26 namespace SlimDX
  27 {
  28         namespace Direct3D9
  29         {
  30                 /// <summary>Describes the presentation parameters of a device.</summary>
  31                 /// <unmanaged>D3DPRESENT_PARAMETERS</unmanaged>
  32                 public ref class PresentParameters : System::ICloneable, System::IEquatable<PresentParameters^>
  33                 {
  34                 internal:
  35                         D3DPRESENT_PARAMETERS ToUnmanaged();
  36                         PresentParameters( const D3DPRESENT_PARAMETERS& d3dpp );
  37
  38                         virtual System::Object^ Clone2() = System::ICloneable::Clone
  39                         {
  40                                 return Clone();
  41                         }
  42
  43                 public:
  44                         /// <summary>
  45                         /// Initializes a new instance of the <see cref="PresentParameters"/> class.
  46                         /// </summary>
  47                         PresentParameters();
  48
  49                         /// <summary>
  50                         /// Gets or sets the width of the back buffer.
  51                         /// </summary>
  52                         property int BackBufferWidth;
  53
  54                         /// <summary>
  55                         /// Gets or sets the height of the back buffer.
  56                         /// </summary>
  57                         property int BackBufferHeight;
  58
  59                         /// <summary>
  60                         /// The back buffer format.
  61                         /// </summary>
  62                         property Format BackBufferFormat;
  63
  64                         /// <summary>
  65                         /// Gets or sets the number of back buffers that will be created.
  66                         /// </summary>
  67                         property int BackBufferCount;
  68
  69                         /// <summary>
  70                         /// Gets or sets the multisampling type.
  71                         /// </summary>
  72                         property MultisampleType Multisample;
  73
  74                         /// <summary>
  75                         /// Gets or sets the quality of the multisampling.
  76                         /// </summary>
  77                         property int MultisampleQuality;
  78
  79                         /// <summary>
  80                         /// Gets or sets the swap effect.
  81                         /// </summary>
  82                         property SwapEffect SwapEffect;
  83
  84                         /// <summary>
  85                         /// Gets or sets the device's window handle.
  86                         /// </summary>
  87                         property System::IntPtr DeviceWindowHandle;
  88
  89                         /// <summary>
  90                         /// Gets or sets a value indicating whether the device will run in windowed or fullscreen mode.
  91                         /// </summary>
  92                         /// <value><c>true</c> to run in windowed mode, <c>false</c> to run in fullscreen mode.</value>
  93                         property bool Windowed;
  94
  95                         /// <summary>
  96                         /// Gets or sets a value indicating whether a depth-stencil surface should be automatically created for the device.
  97                         /// </summary>
  98                         property bool EnableAutoDepthStencil;
  99
 100                         /// <summary>
 101                         /// Gets or sets the format of the automatic depth-stencil buffer.
 102                         /// </summary>
 103                         property Format AutoDepthStencilFormat;
 104
 105                         /// <summary>
 106                         /// Gets or sets flags describing how the device should present its data.
 107                         /// </summary>
 108                         property PresentFlags PresentFlags;
 109
 110                         /// <summary>
 111                         /// Gets or sets the fullscreen refresh rate, in hertz.
 112                         /// </summary>
 113                         property int FullScreenRefreshRateInHertz;
 114
 115                         /// <summary>
 116                         /// Gets or sets the presentation interval.
 117                         /// </summary>
 118                         property PresentInterval PresentationInterval;
 119
 120                         /// <summary>
 121                         /// Clones the instance and returns a new object containing the same values.
 122                         /// </summary>
 123                         /// <returns>A new <see cref="PresentParameters"/> object containing the same values as the current instance.</returns>
 124                         PresentParameters^ Clone();
 125
 126                         /// <summary>
 127                         /// Tests for equality between two objects.
 128                         /// </summary>
 129                         /// <param name="left">The first value to compare.</param>
 130                         /// <param name="right">The second value to compare.</param>
 131                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
 132                         static bool operator == ( PresentParameters^ left, PresentParameters^ right );
 133
 134                         /// <summary>
 135                         /// Tests for inequality between two objects.
 136                         /// </summary>
 137                         /// <param name="left">The first value to compare.</param>
 138                         /// <param name="right">The second value to compare.</param>
 139                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
 140                         static bool operator != ( PresentParameters^ left, PresentParameters^ right );
 141
 142                         /// <summary>
 143                         /// Returns the hash code for this instance.
 144                         /// </summary>
 145                         /// <returns>A 32-bit signed integer hash code.</returns>
 146                         virtual int GetHashCode() override;
 147
 148                         /// <summary>
 149                         /// Returns a value that indicates whether the current instance is equal to a specified object.
 150                         /// </summary>
 151                         /// <param name="obj">Object to make the comparison with.</param>
 152                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
 153                         virtual bool Equals( System::Object^ obj ) override;
 154
 155                         /// <summary>
 156                         /// Returns a value that indicates whether the current instance is equal to the specified object.
 157                         /// </summary>
 158                         /// <param name="other">Object to make the comparison with.</param>
 159                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
 160                         virtual bool Equals( PresentParameters^ other );
 161
 162                         /// <summary>
 163                         /// Determines whether the specified object instances are considered equal.
 164                         /// </summary>
 165                         /// <param name="value1">The first value to compare.</param>
 166                         /// <param name="value2">The second value to compare.</param>
 167                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
 168                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
 169                         static bool Equals( PresentParameters^ value1, PresentParameters^ value2 );
 170                 };
 171         }
 172 }