apple / apple/SwiftUsd

Expose UsdImagingGLEngineWrapper's `GetAovRenderBuffer(_:)` to Swift

Open Beginner friendly
#40 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
87
Forks
14
Avg merge
1d 16h
Merged PRs (30d)
1

Description

Currently, it is not possible to call the `GetAovRenderBuffer(_:)` instance method on `UsdImagingGLEngineWrapper` in Swift, which otherwise currently results in the following compiler error:
```pwsh
Value of type 'Overlay.UsdImagingGLEngineWrapper' has no member 'GetAovRenderBuffer'

C++ method 'GetAovRenderBuffer' that returns a pointer of type 'Optional' is unavailable
C++ method 'GetAovRenderBuffer' may return an interior pointer

_OpenUSD_SwiftBindingHelpers/include/swiftUsd/Wrappers/UsdImagingGLEngineWrapper.h:405:30:
Annotate method 'GetAovRenderBuffer' with 'SWIFT_RETURNS_INDEPENDENT_VALUE' in C++ to make it available in Swift
```

I would be happy to make a PR for this, if you'd like to expose this to Swift.

Contributor guide

Open the contributing guide

Research direction

Start in _OpenUSD_SwiftBindingHelpers/include/swiftUsd/Wrappers/UsdImagingGLEngineWrapper.h at line 405, where GetAovRenderBuffer is declared. Follow the compiler diagnostic's guidance for the required annotation, then verify that the method is callable from Swift without the reported unavailable-method error.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, swift
Domain
api, developer-experience
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.