SlimDXc_Jun2010(VC++2008)/source/dxgi/Surface1.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 "SurfaceDxgi.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace DXGI\r
  29         {\r
  30                 /// <summary>\r
  31                 /// Extends the standard surface interface to provide GDI interop support.\r
  32                 /// </summary>\r
  33                 /// <unmanaged>IDXGISurface1</unmanaged>\r
  34                 public ref class Surface1 : Surface\r
  35                 {\r
  36                         COMOBJECT(IDXGISurface1, Surface1);\r
  37 \r
  38                 public:\r
  39                         /// <summary>\r
  40                         /// Initializes a new instance of the <see cref="Surface1"/> class.\r
  41                         /// </summary>\r
  42                         /// <param name="surface">The COM object implementing the IDXGISurface1 interface.</param>\r
  43                         Surface1( IComObject^ surface );\r
  44 \r
  45                         /// <summary>\r
  46                         /// Returns a device context (DC) that allows you to render to a DXGI surface using GDI.\r
  47                         /// </summary>\r
  48                         /// <param name="discard">If <c>true</c> the application will not preserve any rendering with GDI; otherwise, <c>false</c>. \r
  49                         /// If <c>false</c>, any previous rendering to the device context will be preserved. \r
  50                         /// This flag is ideal for simply reading the device context and not doing any rendering to the surface.</param>\r
  51                         /// <returns>A pointer to an HDC handle that represents the current device context for GDI rendering.</returns>\r
  52                         System::IntPtr GetDC(bool discard);\r
  53 \r
  54                         /// <summary>\r
  55                         /// Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D.\r
  56                         /// </summary>\r
  57                         /// <param name="dirtyRegion">A pointer to a rectangle that identifies the dirty region of the surface. A dirty region is\r
  58                         /// any part of the surface that you have used for GDI rendering and that you want to preserve. This is used as a \r
  59                         /// performance hint to graphics subsystem in certain scenarios. Do not use this parameter to restrict rendering to \r
  60                         /// the specified rectangular region. The area specified by the rectangle will be used as a performance hint to indicate \r
  61                         /// what areas have been manipulated by GDI rendering.</param>\r
  62                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  63                         Result ReleaseDC(System::Drawing::Rectangle dirtyRegion);\r
  64 \r
  65                         /// <summary>\r
  66                         /// Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D.\r
  67                         /// </summary>\r
  68                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>\r
  69                         Result ReleaseDC();\r
  70                 };\r
  71         }\r
  72 }\r