Show / Hide Table of Contents

Struct MouseScroll

Represents the state of a mouse wheel.

Implements
IEquatable<MouseScroll>
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Namespace: OpenTK.Input
Assembly: OpenTK.dll
Syntax
public struct MouseScroll : IEquatable<MouseScroll>

Properties

X

Gets the absolute horizontal offset of the wheel, or 0 if no horizontal scroll wheel exists.

Declaration
public float X { get; }
Property Value
Type Description
Single

The x.

Y

Gets the absolute vertical offset of the wheel, or 0 if no vertical scroll wheel exists.

Declaration
public float Y { get; }
Property Value
Type Description
Single

The y.

Methods

Equals(MouseScroll)

Determines whether the specified MouseScroll is equal to the current MouseScroll.

Declaration
public bool Equals(MouseScroll other)
Parameters
Type Name Description
MouseScroll other

The MouseScroll to compare with the current MouseScroll.

Returns
Type Description
Boolean

true if the specified MouseScroll is equal to the current MouseScroll; otherwise, false.

Equals(Object)

Determines whether the specified Object is equal to the current MouseScroll.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to compare with the current MouseScroll.

Returns
Type Description
Boolean

true if the specified Object is equal to the current MouseScroll; otherwise, false.

Overrides
ValueType.Equals(Object)

GetHashCode()

Serves as a hash function for a MouseScroll object.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

Overrides
ValueType.GetHashCode()

ToString()

Returns a String that represents the current MouseScroll.

Declaration
public override string ToString()
Returns
Type Description
String

A String that represents the current MouseScroll.

Overrides
ValueType.ToString()

Operators

Equality(MouseScroll, MouseScroll)

Declaration
public static bool operator ==(MouseScroll left, MouseScroll right)
Parameters
Type Name Description
MouseScroll left

A MouseScroll instance to test for equality.

MouseScroll right

A MouseScroll instance to test for equality.

Returns
Type Description
Boolean

Inequality(MouseScroll, MouseScroll)

Declaration
public static bool operator !=(MouseScroll left, MouseScroll right)
Parameters
Type Name Description
MouseScroll left

A MouseScroll instance to test for inequality.

MouseScroll right

A MouseScroll instance to test for inequality.

Returns
Type Description
Boolean

Implements

System.IEquatable<T>
In This Article
Back to top Generated by DocFX