Skip to content

Commit

Permalink
Mention wrapping in contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christiangnrd committed Dec 10, 2024
1 parent 7c10d0f commit 3d45135
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 5 additions & 1 deletion docs/src/faq/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ skip the first two steps.
2. Create high-level Julia structures and functionality
3. Create tests for added functionality

`struct`s and `enums` for Objective-C interfaces are automatically generated (see res/wrap/),
so you should not have to define them. If using a struct for the first time in a higher-level
interface, remember to add tests! You may need to define more functions around the structs.

## Mapping to Metal Intrinsics

Some Metal functions map directly to Apple intermediate representation intrinsics. In this
Expand Down Expand Up @@ -134,4 +138,4 @@ their free time helping out. Most anything you're able to do is helpful, but if
stuck, seek guidance from Slack or Discourse. Don't feel like your contribution has to be
perfect. If you put in effort and make progress, there will likely be some senior developer
willing to polish your code before merging. Open-source software is a team effort...welcome
to the team!
to the team!
4 changes: 2 additions & 2 deletions res/wrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

This directory contains scripts to generate Julia wrappers for Metal and MetalPerformanceShaders.

Currently, only `enums` and `structs` are able to be generated.
Currently, only `enums` and `structs` are able to be generated. Don't forget to update the wrappers section in the contributing docs if this changes!

The scripts are meant to be run from this directory, and at the moment, [this Clang.jl branch](https://github.com/christiangnrd/Clang.jl/tree/objectiveC) must be used.

####
--------

Comment from removed file on `MTLDataType`. Parsing the headers does not reveal these hidden values.

Expand Down

0 comments on commit 3d45135

Please sign in to comment.