Blender V5.3
device.mm
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2021-2022 Blender Foundation
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#include "device/device.h"
6
7#ifdef WITH_METAL
8
9# include "device/metal/device.h"
12
13#endif
14
15#include "util/debug.h"
16#include "util/set.h"
17#include "util/system.h"
18
20
21#ifdef WITH_METAL
22
24 Stats &stats,
25 Profiler &profiler,
26 bool headless)
27{
28 return make_unique<MetalDevice>(info, stats, profiler, headless);
29}
30
32{
33 return true;
34}
35
37{
38 MetalDeviceKernels::static_deinitialize();
39}
40
42{
43 auto usable_devices = MetalInfo::get_usable_devices();
44 /* Devices are numbered consecutively across platforms. */
45 set<string> unique_ids;
46 int device_index = 0;
47 for (id<MTLDevice> &device : usable_devices) {
48 /* Compute unique ID for persistent user preferences. */
49 string device_name = MetalInfo::get_device_name(device);
50
51 string id = string("METAL_") + device_name;
52
53 /* Hardware ID might not be unique, add device number in that case. */
54 if (unique_ids.contains(id)) {
55 id += string_printf("_ID_%d", device_index);
56 }
57 unique_ids.insert(id);
58
59 /* Create DeviceInfo. */
60 DeviceInfo info;
61 info.type = DEVICE_METAL;
62 info.description = string_remove_trademark(string(device_name));
63
64 info.num = device_index;
65 /* We don't know if it's used for display, but assume it is. */
66 info.display_device = true;
68 info.id = id;
69# if defined(WITH_OPENIMAGEDENOISE)
70# if OIDN_VERSION >= 20300
71 if (oidnIsMetalDeviceSupported(device)) {
72# else
73 if (OIDNDenoiserGPU::is_device_supported(info)) {
74# endif
76 }
77# endif
78
79 info.has_nanovdb = true;
80 info.has_mnee_ = true;
81 info.use_hardware_raytracing = false;
82
83 /* MetalRT now uses features exposed in Xcode versions corresponding to macOS 14+, so don't
84 * expose it in builds from older Xcode versions. */
85# if defined(MAC_OS_VERSION_14_0)
86 if (@available(macos 14.0, *)) {
87 info.use_hardware_raytracing = device.supportsRaytracing;
88
89 /* Use hardware raytracing for faster rendering on architectures that support it. */
90 info.use_metalrt_by_default = device.supportsRaytracing &&
91 (MetalInfo::get_apple_gpu_architecture(device) >= APPLE_M3);
92 }
93# endif
94
95 devices.push_back(info);
96 device_index++;
97
98 LOG_INFO << "Added device \"" << info.description << "\" with id \"" << info.id << "\".";
99
101 LOG_INFO << "Device with id \"" << info.id << "\" supports "
103 }
104 }
105}
106
108{
109 string result;
110 auto allDevices = MTLCopyAllDevices();
111 uint32_t num_devices = (uint32_t)allDevices.count;
112 if (num_devices == 0) {
113 return "No Metal devices found\n";
114 }
115 result += string_printf("Number of devices: %u\n", num_devices);
116
117 for (id<MTLDevice> device in allDevices) {
118 string device_name = MetalInfo::get_device_name(device);
119 result += string_printf("\t\tDevice: %s\n", device_name.c_str());
120 }
121
122 return result;
123}
124
125#else
126
128 Stats & /*stats*/,
129 Profiler & /*profiler*/)
130{
131 return nullptr;
132}
133
135{
136 return false;
137}
138
140
142{
143 return "";
144}
145
146#endif
147
DenoiserTypeMask denoisers
bool display_device
bool use_metalrt_by_default
DeviceType type
string description
bool use_hardware_raytracing
CCL_NAMESPACE_BEGIN const char * denoiserTypeToHumanReadable(DenoiserType type)
Definition denoise.cpp:9
@ DENOISER_NONE
Definition denoise.h:17
@ DENOISER_OPENIMAGEDENOISE
Definition denoise.h:13
#define CCL_NAMESPACE_END
@ DEVICE_METAL
string device_metal_capabilities()
Definition device.mm:141
unique_ptr< Device > device_metal_create(const DeviceInfo &info, Stats &stats, Profiler &profiler, bool headless)
bool device_metal_init()
Definition device.mm:134
void device_metal_info(vector< DeviceInfo > &devices)
Definition device.mm:139
void device_metal_exit()
#define LOG_INFO
Definition log.h:106
unsigned int uint32_t
Definition BKE_text.h:81
string string_remove_trademark(const string &s)
Definition string.cpp:170
CCL_NAMESPACE_BEGIN string string_printf(const char *format,...)
Definition string.cpp:25