com.io7m.ivoirax.core.IvKeyReleased Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2024 Mark Raynsford  https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */


package com.io7m.ivoirax.core;

/**
 * A key was released.
 *
 * @param index         The key index
 * @param isSynthesized {@code true} if the key was originally pressed with {@link IvPianoType#keyPress(int)}
 */

public record IvKeyReleased(
  int index,
  boolean isSynthesized)
  implements IvKeyEventType
{
  @Override
  public String toString()
  {
    return "[IvKeyReleased %d (isSynthesized %s)]"
      .formatted(this.index, this.isSynthesized);
  }
}