Record Class SDL_CameraSpec

java.lang.Object
java.lang.Record
club.doki7.sdl3.datatype.SDL_CameraSpec
All Implemented Interfaces:
IPointer, ISDL_CameraSpec
@ValueBasedCandidate @UnsafeConstructor public record SDL_CameraSpec(@NotNull MemorySegment segment) extends Record implements ISDL_CameraSpec

The details of an output format for a camera device.

Cameras often support multiple formats; each one will be encapsulated in this struct.

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_GetCameraSupportedFormats
  • SDL_GetCameraFormat

Structure

typedef struct SDL_CameraSpec {
    SDL_PixelFormat format;
    SDL_Colorspace colorspace;
    int width;
    int height;
    int framerate_numerator;
    int framerate_denominator;
} SDL_CameraSpec;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$format

      public static final MemoryLayout.PathElement PATH$format

    • PATH$colorspace

      public static final MemoryLayout.PathElement PATH$colorspace

    • PATH$width

      public static final MemoryLayout.PathElement PATH$width

    • PATH$height

      public static final MemoryLayout.PathElement PATH$height

    • PATH$framerate_numerator

      public static final MemoryLayout.PathElement PATH$framerate_numerator

    • PATH$framerate_denominator

      public static final MemoryLayout.PathElement PATH$framerate_denominator

    • LAYOUT$format

      public static final ValueLayout.OfInt LAYOUT$format

    • LAYOUT$colorspace

      public static final ValueLayout.OfInt LAYOUT$colorspace

    • LAYOUT$width

      public static final ValueLayout.OfInt LAYOUT$width

    • LAYOUT$height

      public static final ValueLayout.OfInt LAYOUT$height

    • LAYOUT$framerate_numerator

      public static final ValueLayout.OfInt LAYOUT$framerate_numerator

    • LAYOUT$framerate_denominator

      public static final ValueLayout.OfInt LAYOUT$framerate_denominator

    • SIZE$format

      public static final long SIZE$format

    • SIZE$colorspace

      public static final long SIZE$colorspace

    • SIZE$width

      public static final long SIZE$width

    • SIZE$height

      public static final long SIZE$height

    • SIZE$framerate_numerator

      public static final long SIZE$framerate_numerator

    • SIZE$framerate_denominator

      public static final long SIZE$framerate_denominator

    • OFFSET$format

      public static final long OFFSET$format

    • OFFSET$colorspace

      public static final long OFFSET$colorspace

    • OFFSET$width

      public static final long OFFSET$width

    • OFFSET$height

      public static final long OFFSET$height

    • OFFSET$framerate_numerator

      public static final long OFFSET$framerate_numerator

    • OFFSET$framerate_denominator

      public static final long OFFSET$framerate_denominator

  • Constructor Details

    • SDL_CameraSpec

      public SDL_CameraSpec(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a SDL_CameraSpec record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static SDL_CameraSpec allocate(Arena arena)

    • allocate

      public static SDL_CameraSpec.Ptr allocate(Arena arena, long count)

    • clone

      public static SDL_CameraSpec clone(Arena arena, SDL_CameraSpec src)

    • format

      @EnumType(SDL_PixelFormat.class) public int format()

    • format

      public SDL_CameraSpec format(@EnumType(SDL_PixelFormat.class) int value)

    • colorspace

      @EnumType(SDL_Colorspace.class) public int colorspace()

    • colorspace

      public SDL_CameraSpec colorspace(@EnumType(SDL_Colorspace.class) int value)

    • width

      public int width()

    • width

      public SDL_CameraSpec width(int value)

    • height

      public int height()

    • height

      public SDL_CameraSpec height(int value)

    • framerate_numerator

      public int framerate_numerator()

    • framerate_numerator

      public SDL_CameraSpec framerate_numerator(int value)

    • framerate_denominator

      public int framerate_denominator()

    • framerate_denominator

      public SDL_CameraSpec framerate_denominator(int value)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • segment

      @NotNull public @NotNull MemorySegment segment()
      Returns the value of the segment record component.
      Specified by:
      segment in interface IPointer
      Returns:
      the value of the segment record component