SlimDXc_Jun2010(VC++2008)/source/direct3d9/CubeTextureRequirements.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>
  31                 /// Contains suggested texture creation parameters for cube textures.
  32                 /// </summary>
  33                 /// <unmanaged>None</unmanaged>
  34                 public value class CubeTextureRequirements : System::IEquatable<CubeTextureRequirements>
  35                 {
  36                 public:
  37                         /// <summary>
  38                         /// The suggested size of the texture, in pixels.
  39                         /// </summary>
  40                         property int Size;
  41
  42                         /// <summary>
  43                         /// The suggested surface format.
  44                         /// </summary>
  45             property Format Format;
  46
  47                         /// <summary>
  48                         /// The suggested mip level count.
  49                         /// </summary>
  50             property int MipLevelCount;
  51
  52                         /// <summary>
  53                         /// Tests for equality between two objects.
  54                         /// </summary>
  55                         /// <param name="left">The first value to compare.</param>
  56                         /// <param name="right">The second value to compare.</param>
  57                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  58                         static bool operator == ( CubeTextureRequirements left, CubeTextureRequirements right );
  59
  60                         /// <summary>
  61                         /// Tests for inequality between two objects.
  62                         /// </summary>
  63                         /// <param name="left">The first value to compare.</param>
  64                         /// <param name="right">The second value to compare.</param>
  65                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  66                         static bool operator != ( CubeTextureRequirements left, CubeTextureRequirements right );
  67
  68                         /// <summary>
  69                         /// Returns the hash code for this instance.
  70                         /// </summary>
  71                         /// <returns>A 32-bit signed integer hash code.</returns>
  72                         virtual int GetHashCode() override;
  73
  74                         /// <summary>
  75                         /// Returns a value that indicates whether the current instance is equal to a specified object.
  76                         /// </summary>
  77                         /// <param name="obj">Object to make the comparison with.</param>
  78                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
  79                         virtual bool Equals( System::Object^ obj ) override;
  80
  81                         /// <summary>
  82                         /// Returns a value that indicates whether the current instance is equal to the specified object.
  83                         /// </summary>
  84                         /// <param name="other">Object to make the comparison with.</param>
  85                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
  86                         virtual bool Equals( CubeTextureRequirements other );
  87
  88                         /// <summary>
  89                         /// Determines whether the specified object instances are considered equal.
  90                         /// </summary>
  91                         /// <param name="value1">The first value to compare.</param>
  92                         /// <param name="value2">The second value to compare.</param>
  93                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
  94                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
  95                         static bool Equals( CubeTextureRequirements% value1, CubeTextureRequirements% value2 );
  96                 };
  97         }
  98 }