org.lwjgl.opencl.AMDDeviceTopology Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-opencl Show documentation

An open, royalty-free standard for cross-platform, parallel programming of diverse processors found in personal computers, servers, mobile devices and embedded platforms.

The newest version!

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.opencl;

/**
 * Native bindings to the amd_device_topology extension.
 * 
 * This extension enables the developer to get a description of the topology used to connect the device to the host.
 */
public final class AMDDeviceTopology {

    /**
     * Accepted as the {@code param_name} parameter of {@link CL10#clGetDeviceInfo GetDeviceInfo}. Returns a description of the topology used to connect the device to the
     * host, using the following 32-bytes union of structures:
     * 
     * 
     * typedef union
     * {
     *     struct { cl_uint type; cl_uint data[5]; } raw;
     *     struct { cl_uint type; cl_char unused[17]; cl_char bus; cl_char device; cl_char function; } pcie;
     * } cl_device_topology_amd;
     * 
     * The type of the structure returned can be queried by reading the first unsigned int of the returned data. The developer can use this type to cast the
     * returned union into the right structure type.
     * 
     * Currently, the only supported type in the structure above is {@link #CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD DEVICE_TOPOLOGY_TYPE_PCIE_AMD}. The information returned contains the PCI
     * Bus/Device/Function of the device, and is similar to the result of the lspci command in Linux. It enables the developer to match between the OpenCL
     * device ID and the physical PCI connection of the card.
     */
    public static final int CL_DEVICE_TOPOLOGY_AMD = 0x4037;

    /** Indicates the type of the struct returned by {@link #CL_DEVICE_TOPOLOGY_AMD DEVICE_TOPOLOGY_AMD}. */
    public static final int CL_DEVICE_TOPOLOGY_TYPE_PCIE_AMD = 1;

    private AMDDeviceTopology() {}

}