Skip to content

New API endpoint for registering texture parameters#50

Open
egorovaanastasiia wants to merge 1 commit into
RS3.0from
DSOF-30790-RSL-TP-improvements
Open

New API endpoint for registering texture parameters#50
egorovaanastasiia wants to merge 1 commit into
RS3.0from
DSOF-30790-RSL-TP-improvements

Conversation

@egorovaanastasiia
Copy link
Copy Markdown

@egorovaanastasiia egorovaanastasiia commented Jun 4, 2026

DSOF-30790

Related PRs:
d3 - https://github.com/disguise-one/d3/pull/5933/
Plugin - disguise-one/RenderStream-UE#140

Note:
Need to update supporting d3 version info when we release RS3.0

Summary by CodeRabbit

  • New Features

    • Added texture parameter registration API for render thread operations
    • Extended schema to include project working colour space field
  • Documentation

    • Updated changelog with new texture parameter requirements and schema additions

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

Walkthrough

This PR exposes a new texture parameter registration function across the RenderStream API stack. A new C API function rs_registerTextureParams() is declared and documented as requiring render-thread invocation. The C++ RenderStream class binds this function via DLL dynamic loading and provides a public wrapper method with error checking.

Changes

Texture Parameters Registration API

Layer / File(s) Summary
C API contract and documentation
src/include/d3renderstream.h, CHANGELOG.md
New exported C function rs_registerTextureParams() declared to return RS_ERROR. Changelog updated with version placeholder (rXX.x), schema requirements (project working colour space field), and render-thread requirement for texture parameter initialization.
C++ wrapper and DLL binding
src/include/renderstream.hpp
Public registerTextureParams() method added to RenderStream class. Internal DLL function pointer declaration, dynamic loading during initialise(), and method implementation that calls the DLL function and validates the result via checkRs().

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A texture parameter takes the stage,
Through C and C++, page by page,
The wrapper calls the DLL's song,
From render threads, where it belongs,
And documentation marks the way! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a new API endpoint (rs_registerTextureParams function) for registering texture parameters, which is the primary purpose of this changeset.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DSOF-30790-RSL-TP-improvements

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 3: Replace the placeholder compatibility token "rXX.x" in the CHANGELOG
entry with the actual disguise designer minimum version (e.g., r3.0 or whatever
the real minimum is) so the support matrix is unambiguous; locate the line
containing the string "Compatible with disguise designer version rXX.x" and
update it to the real version number and, if relevant, adjust the parenthetical
note about RS3.0 to reflect the correct release requirement.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9e42b359-23a8-4eb1-8e6b-8a12fef6c60d

📥 Commits

Reviewing files that changed from the base of the PR and between 816bee8 and 7b11158.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • src/include/d3renderstream.h
  • src/include/renderstream.hpp

Comment thread CHANGELOG.md
# RS3.0

Compatible with disguise designer version r31.1 and above.
Compatible with disguise designer version rXX.x(need to be updated before releasing RS3.0) and above.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace the placeholder compatibility version before merge.

Line 3 still uses rXX.x, which makes the support matrix ambiguous for integrators.

Suggested edit
-Compatible with disguise designer version rXX.x(need to be updated before releasing RS3.0) and above.
+Compatible with disguise designer version r<final_version> and above.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Compatible with disguise designer version rXX.x(need to be updated before releasing RS3.0) and above.
Compatible with disguise designer version r<final_version> and above.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` at line 3, Replace the placeholder compatibility token "rXX.x"
in the CHANGELOG entry with the actual disguise designer minimum version (e.g.,
r3.0 or whatever the real minimum is) so the support matrix is unambiguous;
locate the line containing the string "Compatible with disguise designer version
rXX.x" and update it to the real version number and, if relevant, adjust the
parenthetical note about RS3.0 to reflect the correct release requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant