-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Apple: Enable building as an Apple Framework #2969
base: dev
Are you sure you want to change the base?
Conversation
bc56f55
to
5f321b9
Compare
Filed as internal issue #USD-9360 |
/AzurePipelines run |
Azure Pipelines successfully started running 1 pipeline(s). |
1664609
to
4a0f035
Compare
/AzurePipelines run |
Azure Pipelines successfully started running 1 pipeline(s). |
@dgovil Could I ask you to pop in a note that reports when you are building a framework here?
|
/AzurePipelines run |
Azure Pipelines successfully started running 1 pipeline(s). |
Apologies @dgovil I was meaning to merge locally and got the <- -> icons backwards in the interface. Please force push to overwrite my inadvertent commit when you are ready to update. |
e07ce73
to
352d4d6
Compare
@meshula I rebased the latest on top of dev+ios_core PR. I overwrote your changes to my branch. |
Thanks for fixing the mishap and adding the Mx bits! |
352d4d6
to
947efa1
Compare
/AzurePipelines run |
Pull request contains merge conflicts. |
390e3af
to
8d23ab3
Compare
/AzurePipelines run |
Pull request contains merge conflicts. |
Currently refactoring this on top of the iOS imaging branch and the latest dev, so in flux for the moment. |
/AzurePipelines run |
Pull request contains merge conflicts. |
/AzurePipelines run |
Pull request contains merge conflicts. |
Rebased this PR on the imaging branch. It is still possible to build as a non-monolithic build, but I am not focusing on that setup because frameworks expect a single dylib per framework and we'd have something like ~70 frameworks going that route. Instead, long term, we can work with each dependency to add monolithic+framework builds to them as well, and then tease things apart here. It also allows for building for simulator (but isn't super well tested) My todos before I think this is ready is: [] Make sure the USD build can load all the plugins that are part of it. Specifically HD etc... Potentially, I want to see if its possible to modify the headers to avoid needing to add the header search path manually. |
Looking promising!
If you can solve that one, that would be fantastic! Could I ask you to drop a link in to point us at
Given the evolution of the ios + imaging work, it would be helpful to have a link to the branch out here in the main thread. |
Yep, added a link to the main body above but also adding it here #3215 |
Thanks!! |
7f17ed7
to
d70e1f9
Compare
/AzurePipelines run |
Pull request contains merge conflicts. |
With the latest changes to the PR, the USD plugins under
I need to now check for loading of the plugins that come under |
This PR ports Thor's Imaging work onto the latest USD dev branch. It also includes some patches from Maddy Adams and me to suit the current state of USD and its dependencies. There is a single patch to MaterialX to enable support with USD not using OpenGL builds. Additionally, as requested by Nick Porcino, I have added support for shared memory texture handling on the Mac as well where applicable. I've tested this on macOS with Apple Silicon but do not have Intel macs to test with. I've also tested building this for both iOS and visionOS.
…gic in multiple places
* Note blitCmds.mm is still using the wrong MTLResource type on L.361, which should be MTLBuffer, but that issue is addressed in the following PR: PixarAnimationStudios#3226 Signed-off-by: furby™ <devs@wabi.foundation>
38bc073
to
d18c2ec
Compare
I think it's in a good place if folks want to try it out. I've confirmed that USD is able to register all the plugins like AVIF and Storm. Both this and #3215 are rebased on top of latest dev to remove conflicts. I've also improved the README to better reflect the setup instructions for frameworks. After talking to Nick, we decided to punt the modification of the Header includes. This means users will currently need to add a single path manually to their System Header Search Paths. In the future, we may revisit this once some other future changes for dependencies come to fruition. Feedback is welcome. |
eae649b
to
d18c2ec
Compare
/AzurePipelines run |
Azure Pipelines successfully started running 1 pipeline(s). |
… popped up after rebasing on latest dev
a495043
to
981aa74
Compare
After talking with Maddy, I actually managed to put in a post process in the zsh file that will change the headers. So now users just need to drop the framework into their project and they're off to the races. |
/AzurePipelines run |
Azure Pipelines successfully started running 1 pipeline(s). |
…tional PXR_APPLE_CODESIGN_IDENTITY
Description of Change(s)
This PR enables building of USD as a Framework.
A framework build puts the output files into a directory structure which allows them to be included easily in apps on macOS, iOS and visionOS. The steps to use it are included in the README but are repeated here in brief:
It is based on the Embedded Imaging PR #3215 and so requires that be merged first.
Frameworks are enabled automatically for Apple embedded platforms (iOS, visionOS).
Framework builds default to Monolithic because a framework may only include one dylib within it. Shared builds can still be enabled for some dev purposes, but aren't officially supported.
Experimental Feature
I request that the feature be marked as Experimental in the README, because I anticipate changes might be needed in the future to streamline how this works, such as not requiring the dependencies to be statically built. I think the current state of the PR will unblock the majority of people asking for this feature however and the changes I anticipate might be quite long term.
This incorporates initial work by Maddy Adams and @meshula . The changes are largely non-invasive and are listed below:
Core Code Changes
Build Script Changes
--build-apple-framework
and--no-build-apple-framework
--build-simulator
)Header Notes
Framework headers are automatically discovered when prefixed by the framework name.
E.g instead of
#include <pxr/pxr.h>
you would do#include <OpenUSD/pxr/pxr.h>
If someone wants to avoid the prefixed behavior, they have to manually add the Header directory to their targets
SYSTEM_HEADER_SEARCH_PATHS
.