SlimDXc_Jun2010(VC++2008)/source/math/Half2.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 "../design/Half2Converter.h"
  25
  26 using System::Runtime::InteropServices::OutAttribute;
  27
  28 namespace SlimDX
  29 {
  30         /// <summary>
  31         /// Defines a two component vector, using half precision floating point coordinates.
  32         /// </summary>
  33         /// <unmanaged>D3DXVECTOR2_16F</unmanaged>
  34         [System::Serializable]
  35         [System::Runtime::InteropServices::StructLayout( System::Runtime::InteropServices::LayoutKind::Sequential )]
  36         [System::ComponentModel::TypeConverter( SlimDX::Design::Half2Converter::typeid )]
  37         public value class Half2 : System::IEquatable<Half2>
  38         {
  39         public:
  40                 /// <summary>
  41                 /// Gets or sets the X component of the vector.
  42                 /// </summary>
  43                 /// <value>The X component of the vector.</value>
  44                 Half X;
  45
  46                 /// <summary>
  47                 /// Gets or sets the Y component of the vector.
  48                 /// </summary>
  49                 /// <value>The Y component of the vector.</value>
  50                 Half Y;
  51
  52                 /// <summary>
  53                 /// Initializes a new instance of the <see cref="Half2"/> structure.
  54                 /// </summary>
  55                 /// <param name="value">The value to set for both the X and Y components.</param>
  56                 Half2( Half value );
  57
  58                 /// <summary>
  59                 /// Initializes a new instance of the <see cref="Half2"/> structure.
  60                 /// </summary>
  61                 /// <param name="x">The X component.</param>
  62                 /// <param name="y">The Y component.</param>
  63                 Half2( Half x, Half y );
  64
  65                 /// <summary>
  66                 /// Tests for equality between two objects.
  67                 /// </summary>
  68                 /// <param name="left">The first value to compare.</param>
  69                 /// <param name="right">The second value to compare.</param>
  70                 /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  71                 static bool operator == ( Half2 left, Half2 right );
  72
  73                 /// <summary>
  74                 /// Tests for inequality between two objects.
  75                 /// </summary>
  76                 /// <param name="left">The first value to compare.</param>
  77                 /// <param name="right">The second value to compare.</param>
  78                 /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  79                 static bool operator != ( Half2 left, Half2 right );
  80
  81                 /// <summary>
  82                 /// Returns the hash code for this instance.
  83                 /// </summary>
  84                 /// <returns>A 32-bit signed integer hash code.</returns>
  85                 virtual int GetHashCode() override;
  86
  87                 /// <summary>
  88                 /// Returns a value that indicates whether the current instance is equal to a specified object.
  89                 /// </summary>
  90                 /// <param name="obj">Object to make the comparison with.</param>
  91                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
  92                 virtual bool Equals( System::Object^ obj ) override;
  93
  94                 /// <summary>
  95                 /// Returns a value that indicates whether the current instance is equal to the specified object.
  96                 /// </summary>
  97                 /// <param name="other">Object to make the comparison with.</param>
  98                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
  99                 virtual bool Equals( Half2 other );
 100
 101                 /// <summary>
 102                 /// Determines whether the specified object instances are considered equal.
 103                 /// </summary>
 104                 /// <param name="value1"></param>
 105                 /// <param name="value2"></param>
 106                 /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
 107                 /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
 108                 static bool Equals( Half2% value1, Half2% value2 );
 109         };
 110 }