io.humble.video.PixelComponentDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of humble-video-noarch Show documentation
This is the main Humble Video Java library. It contains no native code, but all Java runtime code. It must be paired up with the correct humble-video-arch-*.jar library for your OS. For most users, depending on humble-video-all will work better.
The newest version!
/* ----------------------------------------------------------------------------
 * This file was automatically generated by SWIG (http://www.swig.org).
 * Version 2.0.6
 *
 * Do not make changes to this file unless you know what you are doing--modify
 * the SWIG interface file instead.
 * ----------------------------------------------------------------------------- */

package io.humble.video;
import io.humble.ferry.*;
/**
 * Describes how different pixel components (e.g. the YUV values) are

 * represented in memory for a given PixelFormat.
 */
public class PixelComponentDescriptor extends RefCounted {
  // JNIHelper.swg: Start generated code
  // >>>>>>>>>>>>>>>>>>>>>>>>>>>
  /**
   * This method is only here to use some references and remove
   * a Eclipse compiler warning.
   */
  @SuppressWarnings("unused")
  private void noop()
  {
    Buffer.make(null, 1);
  }
   
  private volatile long swigCPtr;

  /**
   * Internal Only.
   */
  protected PixelComponentDescriptor(long cPtr, boolean cMemoryOwn) {
    super(VideoJNI.PixelComponentDescriptor_SWIGUpcast(cPtr), cMemoryOwn);
    swigCPtr = cPtr;
  }
  
  /**
   * Internal Only.
   */
  protected PixelComponentDescriptor(long cPtr, boolean cMemoryOwn,
      java.util.concurrent.atomic.AtomicLong ref)
  {
    super(VideoJNI.PixelComponentDescriptor_SWIGUpcast(cPtr),
     cMemoryOwn, ref);
    swigCPtr = cPtr;
  }
    
  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that obj is proxying for.
   *   
   * @param obj The java proxy object for a native object.
   * @return The raw pointer obj is proxying for.
   */
  protected static long getCPtr(PixelComponentDescriptor obj) {
    if (obj == null) return 0;
    return obj.getMyCPtr();
  }

  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that we're proxying for.
   *   
   * @return The raw pointer we're proxying for.
   */  
  protected long getMyCPtr() {
    if (swigCPtr == 0) throw new IllegalStateException("underlying native object already deleted");
    return swigCPtr;
  }
  
  /**
   * Create a new PixelComponentDescriptor object that is actually referring to the
   * exact same underlying native object.
   *
   * @return the new Java object.
   */
  @Override
  public PixelComponentDescriptor copyReference() {
    if (swigCPtr == 0)
      return null;
    else
      return new PixelComponentDescriptor(swigCPtr, swigCMemOwn, getJavaRefCount());
  }

  /**
   * Compares two values, returning true if the underlying objects in native code are the same object.
   *
   * That means you can have two different Java objects, but when you do a comparison, you'll find out
   * they are the EXACT same object.
   *
   * @return True if the underlying native object is the same.  False otherwise.
   */
  public boolean equals(Object obj) {
    boolean equal = false;
    if (obj instanceof PixelComponentDescriptor)
      equal = (((PixelComponentDescriptor)obj).swigCPtr == this.swigCPtr);
    return equal;
  }
  
  /**
   * Get a hashable value for this object.
   *
   * @return the hashable value.
   */
  public int hashCode() {
     return (int)swigCPtr;
  }
  
  // <<<<<<<<<<<<<<<<<<<<<<<<<<<
  // JNIHelper.swg: End generated code
  
/**
 * which of the 4 planes contains the component 
 */
  public int getPlane() {
    return VideoJNI.PixelComponentDescriptor_getPlane(swigCPtr, this);
  }

/**
 * Number of elements between 2 horizontally consecutive pixels minus 1.

 * Elements are bits for bitstream formats, bytes otherwise.
 */
  public int getStepMinus1() {
    return VideoJNI.PixelComponentDescriptor_getStepMinus1(swigCPtr, this);
  }

/**
 * Number of elements before the component of the first pixel plus 1.

 * Elements are bits for bitstream formats, bytes otherwise.
 */
  public int getOffsetPlus1() {
    return VideoJNI.PixelComponentDescriptor_getOffsetPlus1(swigCPtr, this);
  }

/**
 * number of least significant bits that must be shifted away to get the value 
 */
  public int getShift() {
    return VideoJNI.PixelComponentDescriptor_getShift(swigCPtr, this);
  }

/**
 * number of bits in the component minus 1 
 */
  public int getDepthMinus1() {
    return VideoJNI.PixelComponentDescriptor_getDepthMinus1(swigCPtr, this);
  }

}