Skip to content

Commit d7803b2

Browse files
larsgeblarsgeb
committedApr 20, 2022
Add metal-cpp license and readme
1 parent 222c95c commit d7803b2

File tree

2 files changed

+447
-0
lines changed

2 files changed

+447
-0
lines changed
 

‎metal-cpp/LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright © 2021 Apple Inc.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎metal-cpp/README.md

+245
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
## About
2+
3+
**metal-cpp** is a low overhead and header only C++ interface for Metal that helps developers add Metal functionality to graphics applications that are written in C++ (such as game engines). **metal-cpp** removes the need to create a shim and allows developers to call Metal functions directly from anywhere in their existing C++ code.
4+
5+
6+
## Highlights
7+
8+
- Drop in C++ alternative interface to the Metal Objective-C headers.
9+
- Direct mapping of all Metal Objective-C classes, constants and enums to C++ in the MTL C++ namespace.
10+
- No measurable overhead compared to calling Metal Objective-C headers, due to inlining of C++ function calls.
11+
- No usage of wrapper containers that require additional allocations.
12+
- Requires C++17 due to the usage of `constexpr` in `NS::Object`.
13+
- Identical header files and function/constant/enum availability for iOS, macOS and tvOS.
14+
- Backwards compatibility: All `bool MTL::Device::supports...()` functions check if their required selectors exist and automatically return `false` if not.
15+
- String (`ErrorDomain`) constants are weak linked and automatically set to `nullptr` if not available.
16+
17+
## Memory Allocation Policy
18+
19+
**metal-cpp** follows the object allocation policies of Cocoa and Cocoa Touch. Understanding those rules is especially important when using metal-cpp, as C++ objects are not eligible for automatic reference counting (ARC).
20+
21+
**metal-cpp** objects are reference counted. To help convey and manage object lifecycles, the following conventions are observed:
22+
23+
1. *You own any object returned by methods whose name begins with* `alloc` *,* `new` *,* `copy` *, or* `mutableCopy`. The method returns these objects with `retainCount` equals to `1`.
24+
2. *You can take ownership of an object by calling its* ```retain()``` *method*. A received object is normally guaranteed to remain valid within the method it was received in. You use `retain` in two situations: (1) In the implementation of an accessor method (a setter) or to take ownership of an object; and (2) To prevent an object from being deallocated as a side-effect of some other operation.
25+
3. *When you no longer need it, you must relinquish ownership of an object you own*. You relinquish ownership by calling its `release()` or `autorelease()` method.
26+
4. *You must not relinquish ownership of an object you do not own*.
27+
28+
When an object's `retainCount` reaches `0`, the object is immediately deallocated. It is illegal to call methods on a deallocated object and it may lead to an application crash.
29+
30+
### AutoreleasePools and Objects
31+
32+
Several methods that create temporary objects in **metal-cpp** add them to an `AutoreleasePool` to help manage their lifetimes. In these situations, after **metal-cpp** creates the object, it adds it to an `AutoreleasePool`, which will release its objects when you release (or drain) it.
33+
34+
By adding temporary objects to an AutoreleasePool, you do not need to explicitly call `release()` to deallocate them. Instead, you can rely on the `AutoreleasePool` to implicitly manage those lifetimes.
35+
36+
If you create an object with a method that does not begin with `alloc`, `new`, `copy`, or `mutableCopy`, the creating method adds the object to an autorelease pool.
37+
38+
The typical scope of an `AutoreleasePool` is one frame of rendering for the main thread of the program. When the thread returns control to the RunLoop (an object responsible for receiving input and events from the windowing system), the pool is *drained*, releasing its objects.
39+
40+
You can create and manage additional `AutoreleasePool`s at smaller scopes to reduce your program's working set, and you are required to do so for any additional threads your program creates.
41+
42+
If an object's lifecycle needs to be extended beyond the `AutoreleasePool`'s scope, you can claim ownership of it (avoiding its release beyond the pool's scope) by calling its `retain()` method before its pool is drained. In these cases, you will be responsible for making the appropriate `release()` call on the object after you no longer need it.
43+
44+
You can find a more-detailed introduction to the memory management rules here: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/MemoryMgmt/Articles/mmRules.html.
45+
46+
For more details about the application's RunLoop, please find its documentation here: https://developer.apple.com/documentation/foundation/nsrunloop
47+
48+
### Use and debug AutoreleasePools
49+
50+
When you create an autoreleased object and there is no enclosing `AutoreleasePool`, the object is leaked.
51+
52+
To prevent this, you normally create an `AutoreleasePool` in your program's `main` function, and in the entry function for every thread you create. You may also create additional `AutoreleasePool`s to avoid growing your program's high memory watermark when you create several autoreleased objects, such as when rendering.
53+
54+
Use the Environment Variable `OBJC_DEBUG_MISSING_POOLS=YES` to print a runtime warning when an autoreleased object is leaked because no enclosing `AutoreleasePool` is available for its thread.
55+
56+
You can also run `leaks --autoreleasePools` on a memgraph file or a process ID (macOS only) to view a listing of your program's `AutoreleasePool`s and all objects they contain.
57+
58+
### nullptr
59+
60+
Similar to Objective-C, it is legal to call any method, including `retain()` and `release()`, on `nullptr` "objects". While calling methods on `nullptr` still does incur in function call overhead, the effective result is equivalent of a NOP.
61+
62+
Conversely, do not assume that because calling a method on a pointer did not result in a crash, that the pointed-to object is valid.
63+
64+
## Adding metal-cpp to a Project
65+
66+
Simply include `Metal/Metal.hpp`. To ensure that the selector and class symbols are linked, add to one of your cpp files:
67+
68+
```cpp
69+
#define NS_PRIVATE_IMPLEMENTATION
70+
#define MTL_PRIVATE_IMPLEMENTATION
71+
72+
#include "Metal/Metal.hpp"
73+
```
74+
75+
If you want to use the QuartzCore wrapper, add:
76+
77+
```cpp
78+
#define CA_PRIVATE_IMPLEMENTATION
79+
80+
#include "QuartzCore/QuartzCore.hpp"
81+
```
82+
83+
## Generating a Single Header File
84+
85+
Purely optional: You can generate a single header file that contains all **metal-cpp** headers via:
86+
87+
```shell
88+
./SingleHeader/MakeSingleHeader.py Foundation/Foundation.hpp QuartzCore/QuartzCore.hpp Metal/Metal.hpp
89+
```
90+
91+
By default the generated header file will be written to `./SingleHeader/Metal.hpp`
92+
93+
## Examples
94+
95+
#### Creating the device
96+
97+
###### Objective-C (with automatic reference counting)
98+
99+
```objc
100+
id< MTLDevice > device = MTLCreateSystemDefaultDevice();
101+
102+
// ...
103+
```
104+
105+
###### Objective-C
106+
107+
```objc
108+
id< MTLDevice > device = MTLCreateSystemDefaultDevice();
109+
110+
// ...
111+
112+
[device release];
113+
```
114+
115+
###### C++
116+
117+
```cpp
118+
MTL::Device* pDevice = MTL::CreateSystemDefaultDevice();
119+
120+
// ...
121+
122+
pDevice->release();
123+
```
124+
125+
#### Metal function calls map directly to C++
126+
127+
###### Objective-C (with automatic reference counting)
128+
129+
```objc
130+
MTLSamplerDescriptor* samplerDescriptor = [[MTLSamplerDescriptor alloc] init];
131+
132+
[samplerDescriptor setSAddressMode: MTLSamplerAddressModeRepeat];
133+
[samplerDescriptor setTAddressMode: MTLSamplerAddressModeRepeat];
134+
[samplerDescriptor setRAddressMode: MTLSamplerAddressModeRepeat];
135+
[samplerDescriptor setMagFilter: MTLSamplerMinMagFilterLinear];
136+
[samplerDescriptor setMinFilter: MTLSamplerMinMagFilterLinear];
137+
[samplerDescriptor setMipFilter: MTLSamplerMipFilterLinear];
138+
[samplerDescriptor setSupportArgumentBuffers: YES];
139+
140+
id< MTLSamplerState > samplerState = [device newSamplerStateWithDescriptor:samplerDescriptor];
141+
```
142+
143+
###### Objective-C
144+
145+
```objc
146+
MTLSamplerDescriptor* samplerDescriptor = [[MTLSamplerDescriptor alloc] init];
147+
148+
[samplerDescriptor setSAddressMode: MTLSamplerAddressModeRepeat];
149+
[samplerDescriptor setTAddressMode: MTLSamplerAddressModeRepeat];
150+
[samplerDescriptor setRAddressMode: MTLSamplerAddressModeRepeat];
151+
[samplerDescriptor setMagFilter: MTLSamplerMinMagFilterLinear];
152+
[samplerDescriptor setMinFilter: MTLSamplerMinMagFilterLinear];
153+
[samplerDescriptor setMipFilter: MTLSamplerMipFilterLinear];
154+
[samplerDescriptor setSupportArgumentBuffers: YES];
155+
156+
id< MTLSamplerState > samplerState = [device newSamplerStateWithDescriptor:samplerDescriptor];
157+
158+
[samplerDescriptor release];
159+
160+
// ...
161+
162+
[samplerState release];
163+
```
164+
165+
###### C++
166+
167+
```cpp
168+
MTL::SamplerDescriptor* pSamplerDescriptor = MTL::SamplerDescriptor::alloc()->init();
169+
170+
pSamplerDescriptor->setSAddressMode( MTL::SamplerAddressModeRepeat );
171+
pSamplerDescriptor->setTAddressMode( MTL::SamplerAddressModeRepeat );
172+
pSamplerDescriptor->setRAddressMode( MTL::SamplerAddressModeRepeat );
173+
pSamplerDescriptor->setMagFilter( MTL::SamplerMinMagFilterLinear );
174+
pSamplerDescriptor->setMinFilter( MTL::SamplerMinMagFilterLinear );
175+
pSamplerDescriptor->setMipFilter( MTL::SamplerMipFilterLinear );
176+
pSamplerDescriptor->setSupportArgumentBuffers( true );
177+
178+
MTL::SamplerState* pSamplerState = pDevice->newSamplerState( pSamplerDescriptor );
179+
180+
pSamplerDescriptor->release();
181+
182+
// ...
183+
184+
pSamplerState->release();
185+
```
186+
187+
#### A subset of bindings for Foundation classes is provided for seamless integration
188+
189+
###### Objective-C (with automatic reference counting)
190+
191+
```objc
192+
NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
193+
NSString* string = [NSString stringWithCString: "Hello World" encoding: NSASCIIStringEncoding];
194+
195+
printf( "string = \"%s\"\n", [string cStringUsingEncoding: NSASCIIStringEncoding] );
196+
```
197+
198+
###### Objective-C
199+
200+
```objc
201+
NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
202+
NSString* string = [NSString stringWithCString: "Hello World" encoding: NSASCIIStringEncoding];
203+
204+
printf( "string = \"%s\"\n", [string cStringUsingEncoding: NSASCIIStringEncoding] );
205+
206+
[pool release];
207+
```
208+
209+
###### C++
210+
211+
```cpp
212+
NS::AutoreleasePool* pPool = NS::AutoreleasePool::alloc()->init();
213+
NS::String* pString = NS::String::string( "Hello World", NS::ASCIIStringEncoding );
214+
215+
printf( "pString = \"%s\"\n", pString->cString( NS::ASCIIStringEncoding ) );
216+
217+
pPool->release();
218+
```
219+
220+
#### Interoperability with CoreFoundation
221+
222+
```cpp
223+
MTL::AccelerationStructureTriangleGeometryDescriptor* pGeoDescriptor = MTL::AccelerationStructureTriangleGeometryDescriptor::alloc()->init();
224+
CFTypeRef descriptors[] = { ( CFTypeRef )( pGeoDescriptor ) };
225+
NS::Array* pGeoDescriptors = ( NS::Array* )( CFArrayCreate( kCFAllocatorDefault, descriptors, SIZEOF_ARRAY( descriptors), &kCFTypeArrayCallBacks ) );
226+
227+
// ...
228+
229+
pGeoDescriptors->release();
230+
```
231+
232+
#### Accessing a CAMetalDrawable
233+
234+
```objc
235+
#import <QuartzCore/CAMetalLayer.h>
236+
#import <QuartzCore/QuartzCore.hpp>
237+
238+
// ...
239+
240+
CAMetalLayer* metalLayer = /* get your layer from your view */;
241+
id< CAMetalDrawable > metalDrawable = [metalLayer nextDrawable];
242+
CA::MetalDrawable* pMetalCppDrawable = ( __bridge CA::MetalDrawable* ) metalDrawable;
243+
244+
// ...
245+
```

0 commit comments

Comments
 (0)
Please sign in to comment.