test/source/blender/python/gpu/gpu_py_platform.cc

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup bpygpu
 *
 * - Use `bpygpu_` for local API.
 * - Use `BPyGPU` for public API.
 */

#include <Python.h>

#include "BLI_utildefines.h"

#include "GPU_context.hh"
#include "GPU_platform.hh"

#include "gpu_py.hh"
#include "gpu_py_platform.hh" /* Own include. */

/* -------------------------------------------------------------------- */
/** \name Functions
 * \{ */

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform_vendor_get_doc,
    ".. function:: vendor_get()\n"
    "\n"
    "   Get GPU vendor.\n"
    "\n"
    "   :return: Vendor name.\n"
    "   :rtype: str\n");
static PyObject *pygpu_platform_vendor_get(PyObject * /*self*/)
{
  BPYGPU_IS_INIT_OR_ERROR_OBJ;

  return PyUnicode_FromString(GPU_platform_vendor());
}

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform_renderer_get_doc,
    ".. function:: renderer_get()\n"
    "\n"
    "   Get GPU to be used for rendering.\n"
    "\n"
    "   :return: GPU name.\n"
    "   :rtype: str\n");
static PyObject *pygpu_platform_renderer_get(PyObject * /*self*/)
{
  BPYGPU_IS_INIT_OR_ERROR_OBJ;

  return PyUnicode_FromString(GPU_platform_renderer());
}

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform_version_get_doc,
    ".. function:: version_get()\n"
    "\n"
    "   Get GPU driver version.\n"
    "\n"
    "   :return: Driver version.\n"
    "   :rtype: str\n");
static PyObject *pygpu_platform_version_get(PyObject * /*self*/)
{
  BPYGPU_IS_INIT_OR_ERROR_OBJ;

  return PyUnicode_FromString(GPU_platform_version());
}

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform_device_type_get_doc,
    ".. function:: device_type_get()\n"
    "\n"
    "   Get GPU device type.\n"
    "\n"
    "   :return: Device type ('APPLE', 'NVIDIA', 'AMD', 'INTEL', 'SOFTWARE', 'QUALCOMM', "
    "'UNKNOWN').\n"
    "   :rtype: str\n");
static PyObject *pygpu_platform_device_type_get(PyObject * /*self*/)
{
  BPYGPU_IS_INIT_OR_ERROR_OBJ;

  const char *device;
  if (GPU_type_matches(GPU_DEVICE_APPLE, GPU_OS_ANY, GPU_DRIVER_ANY)) {
    device = "APPLE";
  }
  else if (GPU_type_matches(GPU_DEVICE_NVIDIA, GPU_OS_ANY, GPU_DRIVER_ANY)) {
    device = "NVIDIA";
  }
  else if (GPU_type_matches(GPU_DEVICE_ATI, GPU_OS_ANY, GPU_DRIVER_ANY)) {
    device = "AMD";
  }
  else if (GPU_type_matches(GPU_DEVICE_INTEL | GPU_DEVICE_INTEL_UHD, GPU_OS_ANY, GPU_DRIVER_ANY)) {
    device = "INTEL";
  }
  else if (GPU_type_matches(GPU_DEVICE_SOFTWARE, GPU_OS_ANY, GPU_DRIVER_ANY)) {
    device = "SOFTWARE";
  }
  /* Right now we can only detect Qualcomm GPUs on Windows, not other OSes */
  else if (GPU_type_matches(GPU_DEVICE_QUALCOMM, GPU_OS_WIN, GPU_DRIVER_ANY)) {
    device = "QUALCOMM";
  }
  else {
    device = "UNKNOWN";
  }
  return PyUnicode_FromString(device);
}

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform_backend_type_get_doc,
    ".. function:: backend_type_get()\n"
    "\n"
    "   Get actuve GPU backend.\n"
    "\n"
    "   :return: Backend type ('OPENGL', 'VULKAN', 'METAL', 'NONE', 'UNKNOWN').\n"
    "   :rtype: str\n");
static PyObject *pygpu_platform_backend_type_get(PyObject * /*self*/)
{
  BPYGPU_IS_INIT_OR_ERROR_OBJ;

  const char *backend = "UNKNOWN";
  switch (GPU_backend_get_type()) {
    case GPU_BACKEND_VULKAN: {
      backend = "VULKAN";
      break;
    }
    case GPU_BACKEND_METAL: {
      backend = "METAL";
      break;
    }
    case GPU_BACKEND_NONE: {
      backend = "NONE";
      break;
    }
    case GPU_BACKEND_OPENGL: {
      backend = "OPENGL";
      break;
    }
    case GPU_BACKEND_ANY:
      break;
  }
  return PyUnicode_FromString(backend);
}

/** \} */

/* -------------------------------------------------------------------- */
/** \name Module
 * \{ */

#if (defined(__GNUC__) && !defined(__clang__))
#  pragma GCC diagnostic push
#  pragma GCC diagnostic ignored "-Wcast-function-type"
#endif

static PyMethodDef pygpu_platform__tp_methods[] = {
    {"vendor_get",
     (PyCFunction)pygpu_platform_vendor_get,
     METH_NOARGS,
     pygpu_platform_vendor_get_doc},
    {"renderer_get",
     (PyCFunction)pygpu_platform_renderer_get,
     METH_NOARGS,
     pygpu_platform_renderer_get_doc},
    {"version_get",
     (PyCFunction)pygpu_platform_version_get,
     METH_NOARGS,
     pygpu_platform_version_get_doc},
    {"device_type_get",
     (PyCFunction)pygpu_platform_device_type_get,
     METH_NOARGS,
     pygpu_platform_device_type_get_doc},
    {"backend_type_get",
     (PyCFunction)pygpu_platform_backend_type_get,
     METH_NOARGS,
     pygpu_platform_backend_type_get_doc},
    {nullptr, nullptr, 0, nullptr},
};

#if (defined(__GNUC__) && !defined(__clang__))
#  pragma GCC diagnostic pop
#endif

PyDoc_STRVAR(
    /* Wrap. */
    pygpu_platform__tp_doc,
    "This module provides access to GPU Platform definitions.");
static PyModuleDef pygpu_platform_module_def = {
    /*m_base*/ PyModuleDef_HEAD_INIT,
    /*m_name*/ "gpu.platform",
    /*m_doc*/ pygpu_platform__tp_doc,
    /*m_size*/ 0,
    /*m_methods*/ pygpu_platform__tp_methods,
    /*m_slots*/ nullptr,
    /*m_traverse*/ nullptr,
    /*m_clear*/ nullptr,
    /*m_free*/ nullptr,
};

PyObject *bpygpu_platform_init()
{
  PyObject *submodule;

  submodule = PyModule_Create(&pygpu_platform_module_def);

  return submodule;
}

/** \} */