SlimDXc_Jun2010(VC++2008)/source/DataRectangle.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         ref class DataStream;\r
  27 \r
  28         /// <summary>\r
  29         /// A DataRectangle provides supporting information for a <see cref="SlimDX::DataStream"/> whose\r
  30         /// data is organized within two dimensions (a rectangle).\r
  31         /// </summary>\r
  32         /// <unmanaged>None</unmanaged>\r
  33         public ref class DataRectangle\r
  34         {\r
  35         private:\r
  36                 int m_Pitch;\r
  37                 DataStream^ m_Data;\r
  38 \r
  39         public:\r
  40                 /// <summary>\r
  41                 /// Initializes a new instance of the <see cref="DataRectangle"/> class.\r
  42                 /// </summary>\r
  43                 /// <param name="pitch">The row pitch, in bytes.</param>\r
  44                 /// <param name="data">The data.</param>\r
  45                 DataRectangle( int pitch, DataStream^ data );\r
  46 \r
  47                 /// <summary>\r
  48                 /// Gets or sets the number of bytes of data between two consecutive (1D) rows of data.\r
  49                 /// </summary>\r
  50                 property int Pitch\r
  51                 {\r
  52                         int get();\r
  53                         void set(int value);\r
  54                 }\r
  55 \r
  56                 /// <summary>\r
  57                 /// Gets the <see cref="SlimDX::DataStream"/> containing the actual data bytes.\r
  58                 /// </summary>\r
  59                 property DataStream^ Data\r
  60                 {\r
  61                         DataStream^ get();\r
  62                 }\r
  63         };\r
  64 }\r
  65 \r