Package foundry.veil.api.opencl

Record Class VeilOpenCL.PlatformInfo

java.lang.Object
java.lang.Record
foundry.veil.api.opencl.VeilOpenCL.PlatformInfo
Record Components:
id - The id of this platform
capabilities - The capabilities supported on this platform
profile - The profile name supported by the implementation
version - OpenCL version string
name - Platform name string
vendor - Platform vendor string
devices - The list of devices available on this platform
Enclosing class:
VeilOpenCL
public static record VeilOpenCL.PlatformInfo(long id, org.lwjgl.opencl.CLCapabilities capabilities, String profile, String version, String name, String vendor, VeilOpenCL.DeviceInfo[] devices) extends Record
Information about a platform that can run OpenCL.

  • Constructor Details

    • PlatformInfo

      public PlatformInfo(long id, org.lwjgl.opencl.CLCapabilities capabilities, String profile, String version, String name, String vendor, VeilOpenCL.DeviceInfo[] devices)
      Creates an instance of a PlatformInfo record class.
      Parameters:
      id - the value for the id record component
      capabilities - the value for the capabilities record component
      profile - the value for the profile record component
      version - the value for the version record component
      name - the value for the name record component
      vendor - the value for the vendor record component
      devices - the value for the devices record component

  • Method Details

    • create

      public static VeilOpenCL.PlatformInfo create(long platform, org.lwjgl.system.MemoryStack stack) throws CLException
      Throws:
      CLException

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • id

      public long id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • capabilities

      public org.lwjgl.opencl.CLCapabilities capabilities()
      Returns the value of the capabilities record component.
      Returns:
      the value of the capabilities record component

    • profile

      public String profile()
      Returns the value of the profile record component.
      Returns:
      the value of the profile record component

    • version

      public String version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • vendor

      public String vendor()
      Returns the value of the vendor record component.
      Returns:
      the value of the vendor record component

    • devices

      public VeilOpenCL.DeviceInfo[] devices()
      Returns the value of the devices record component.
      Returns:
      the value of the devices record component