ScaleMode

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.epiphan.vga2usb
Class ScaleMode

    Object
      com.epiphan.vga2usb.Enum
          com.epiphan.vga2usb.Enum.Int
              com.epiphan.vga2usb.ScaleMode

All Implemented Interfaces:
  Comparable

public final class ScaleMode
extends com.epiphan.vga2usb.Enum.Int

Typesafe enumeration of scaling algorithms supported by the driver.

Since:
  3.27.1

Field Summary
`static ScaleMode` | `Area` Yet another weighted average algorithm.
`static ScaleMode` | `Bicubic` Bicubic algorithm.
`static ScaleMode` | `BicubLin` Luma bicubic, chroma bilinear.
`static ScaleMode` | `Bilinear` Bilinear algorithm.
`static ScaleMode` | `Experimental` Experimental algorithm.
`static ScaleMode` | `FastBilinear` Fast bilinear algorithm.
`static ScaleMode` | `Lanczos` Lanczos algorithm.
`static ScaleMode` | `NearestNeighbor` Nearest neighbor algorithm.
`static ScaleMode` | `None` No scaling
`static ScaleMode` | `Point` Yet another nearest neighbor algorithm.
`static ScaleMode` | `Sinc` Sinc algorithm.
`static ScaleMode` | `Spline` Natural bicubic spline algorithm.
`static ScaleMode` | `WeightedAverage` Weighted average algorithm.

Method Summary
`int` | `compareTo(int key)` Compares id of this object with the specified key for order.
`int` | `compareTo(Object obj)` Compares this object with the specified object for order.
`String` | `getDescription()` Returns the description of this object.
`static ScaleMode` | `getScaleMode(int value)` Converts native scale mode value into a `ScaleMode` object.
`int` | `getValue()` Gets the integer value associated with this object.
`int` | `hashCode()` Returns the hashcode for this object.
`protected static int` | `search(java.util.List list, int key)` Searches the list for the specified enum object using the binary search algorithm.
`String` | `toString()` Returns a string representation of this object.

Methods inherited from class Object
`clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### Area

    public static final ScaleMode Area

  Yet another weighted average algorithm.

### Bicubic

    public static final ScaleMode Bicubic

  Bicubic algorithm.

### BicubLin

    public static final ScaleMode BicubLin

  Luma bicubic, chroma bilinear.

### Bilinear

    public static final ScaleMode Bilinear

  Bilinear algorithm.

### Experimental

    public static final ScaleMode Experimental

  Experimental algorithm.

### FastBilinear

    public static final ScaleMode FastBilinear

  Fast bilinear algorithm.

### Lanczos

    public static final ScaleMode Lanczos

  Lanczos algorithm.

### NearestNeighbor

    public static final ScaleMode NearestNeighbor

  Nearest neighbor algorithm.

### None

    public static final ScaleMode None

  No scaling

### Point

    public static final ScaleMode Point

  Yet another nearest neighbor algorithm.

### Sinc

    public static final ScaleMode Sinc

  Sinc algorithm.

### Spline

    public static final ScaleMode Spline

  Natural bicubic spline algorithm.

### WeightedAverage

    public static final ScaleMode WeightedAverage

  Weighted average algorithm.

Method Detail

### getScaleMode

    public static ScaleMode getScaleMode(int value)

  Converts native scale mode value into a `ScaleMode` object.

  Parameters:
    `value` - integer value that identifies the scale mode
  Returns:
    corresponding `ScaleMode` object

### compareTo

    public int compareTo(int key)

  Compares id of this object with the specified key for order. Returns a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.

  Parameters:
    `key` - the key to be compared.
  Returns:
    a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### compareTo

    public int compareTo(Object obj)

  Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

  Specified by:
    `compareTo` in interface `Comparable`
  Parameters:
    `obj` - the Object to be compared.
  Returns:
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### getValue

    public final int getValue()

  Gets the integer value associated with this object.

  Returns:
    The integer value that identifies this object

### hashCode

    public final int hashCode()

  Returns the hashcode for this object.

  Returns:
    The hashcode for this object.

### search

    protected static int search(java.util.List list,
                                int key)

  Searches the list for the specified enum object using the binary search algorithm. The list must be sorted.

  Parameters:
    `list` - the list to search
    `key` - the key to search for
  Returns:
    index of the enum object, if it is contained in the list; otherwise, `(-(insertion point) - 1)`.

### getDescription

    public final String getDescription()

  Returns the description of this object.

  Returns:
    The description of this object.

### toString

    public final String toString()

  Returns a string representation of this object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`.

  Returns:
    A string representation of this object.

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2012 Epiphan Systems Inc. All rights reserved.