110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/direct3d9/DisplayModeEx.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 "Enums.h"\r
  25 #include "DisplayModeFilter.h"\r
  26 \r
  27 namespace SlimDX\r
  28 {\r
  29         namespace Direct3D9\r
  30         {\r
  31                 ref class Direct3D;\r
  32 \r
  33                 /// <summary>Describes an extended display mode.</summary>\r
  34                 /// <unmanaged>D3DDISPLAYMODEEX</unmanaged>\r
  35                 [System::Runtime::InteropServices::StructLayout( System::Runtime::InteropServices::LayoutKind::Sequential )]\r
  36                 public value class DisplayModeEx : System::IEquatable<DisplayModeEx>\r
  37                 {\r
  38                 internal:\r
  39                         static DisplayModeEx FromUnmanaged( const D3DDISPLAYMODEEX& mode );\r
  40                         D3DDISPLAYMODEEX ToUnmanaged();\r
  41 \r
  42                 public:\r
  43                         /// <summary>\r
  44                         /// Screen width, in pixels.\r
  45                         /// </summary>\r
  46                         property int Width;\r
  47 \r
  48                         /// <summary>\r
  49                         /// Screen height, in pixels.\r
  50                         /// </summary>\r
  51             property int Height;\r
  52 \r
  53                         /// <summary>\r
  54                         /// Refresh rate of the monitor.\r
  55                         /// </summary>\r
  56             property int RefreshRate;\r
  57 \r
  58                         /// <summary>\r
  59                         /// The surface format of the display mode.\r
  60                         /// </summary>\r
  61             property Format Format;\r
  62 \r
  63                         /// <summary>\r
  64                         /// The scanline ordering used by the display mode.\r
  65                         /// </summary>\r
  66                         property ScanlineOrdering ScanlineOrdering;\r
  67 \r
  68                         property float AspectRatio\r
  69                         {\r
  70                                 float get() { return static_cast<float>(Width) / static_cast<float>(Height); }\r
  71                         }\r
  72 \r
  73                         /// <summary>\r
  74                         /// Tests for equality between two objects.\r
  75                         /// </summary>\r
  76                         /// <param name="left">The first value to compare.</param>\r
  77                         /// <param name="right">The second value to compare.</param>\r
  78                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  79                         static bool operator == ( DisplayModeEx left, DisplayModeEx right );\r
  80 \r
  81                         /// <summary>\r
  82                         /// Tests for inequality between two objects.\r
  83                         /// </summary>\r
  84                         /// <param name="left">The first value to compare.</param>\r
  85                         /// <param name="right">The second value to compare.</param>\r
  86                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  87                         static bool operator != ( DisplayModeEx left, DisplayModeEx right );\r
  88 \r
  89                         /// <summary>\r
  90                         /// Returns the hash code for this instance.\r
  91                         /// </summary>\r
  92                         /// <returns>A 32-bit signed integer hash code.</returns>\r
  93                         virtual int GetHashCode() override;\r
  94 \r
  95                         /// <summary>\r
  96                         /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  97                         /// </summary>\r
  98                         /// <param name="obj">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( System::Object^ obj ) override;\r
 101 \r
 102                         /// <summary>\r
 103                         /// Returns a value that indicates whether the current instance is equal to the specified object. \r
 104                         /// </summary>\r
 105                         /// <param name="other">Object to make the comparison with.</param>\r
 106                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
 107                         virtual bool Equals( DisplayModeEx other );\r
 108 \r
 109                         /// <summary>\r
 110                         /// Determines whether the specified object instances are considered equal. \r
 111                         /// </summary>\r
 112                         /// <param name="value1">The first value to compare.</param>\r
 113                         /// <param name="value2">The second value to compare.</param>\r
 114                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
 115                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
 116                         static bool Equals( DisplayModeEx% value1, DisplayModeEx% value2 );\r
 117                 };\r
 118 \r
 119                 /// <summary>Implements a read-only collection of <see cref="DisplayMode"/> instances.</summary>\r
 120                 public ref class DisplayModeExCollection : public System::Collections::ObjectModel::ReadOnlyCollection<DisplayModeEx>\r
 121                 {\r
 122                 internal:\r
 123                         DisplayModeExCollection( IDirect3D9Ex *direct3D, unsigned int adapter, DisplayModeFilter filter );\r
 124                 };\r
 125         }\r
 126 }