Repository files navigation

• 4.1, 4.2, 4.3
• 4.0

For older Blender versions, seereleases.

• AMD GPUs (Vega, Navi 1x, Navi 2x, Navi 3x)
• NVIDIA GPUs
• Apple Mx GPUs
• AMD, Intel CPUs

• Blender 4.1+
• Python 3.11 (Blender 4.1 uses 3.11) x64(for Core) - all code, addon and misc tested with python3
• python-cffi
  • py -3.11 -m pip install cffi
  • py -3.11 -m pip install numpy
• Visual Studio 2015 SP3 / 2017 / 2019 with SDK 8.1 and 2015.3 v140 toolset installed
• If you are using Visual studio 2019 you would need to install the Windows SDK 8.1 manually from Microsoft websitehttps://developer.microsoft.com/en-us/windows/downloads/sdk-archive/
• cmake 3.x. Make sure it's added to the PATH environment variable

Note that the .sln provided is for easy editing and searching of files on Windows. The blender code builds on the command line rather than in the solution file. Visual Studio does provided support for debugging Python when you attach to the running Blender process with loaded addon.

Plugin includes 4 submodules:

• RadeonProRender SDK
• Shared components
• Image Processing Library
• ThirdParty components and miscellaneous tools

Please update submodules:

git submodule update --init -f --recursive

runbuild.py to build.

• make sure you have no installed addon for Blender version you want to use; remove installed version if needed.
• set environment variable BLENDER_EXE to blender.exe you want to use via the command line or system environment settings.
• run run_blender_with_rpr.cmd

Example:

set BLENDER_EXE="C:\Program Files\Blender Foundation\Blender 2.93\blender.exe" && run_blender_with_rpr.cmd

Aim is to conform topep8.At minimum it's 4 spaces for indentation, sources are utf-8, there's .gitconfig in the root of the project - please set you editor to use it(for most simplicity). E.g. PyCharm(recommended!) default setting are fine and seems that it also picks up .editorconfig automatically also, Tortoise Merge has a checkbox 'Enable EditorConfig', for Visual Studio there'sEditorConfig extension

Git - we try to avoid merge commits, easiest way to do it:

git config [--global] merge.ff only # this one rejects merges that would result in merge commit

git config [--global] pull.rebase true # converts pull to do, essentially, fetch&rebase

Also, make more meaningful commits(one commit per feature) the easy way:

git merge <branch> --squash # this will create a single change set from multiple commits coming from<branch>

Using python's 'logging' module underneath, rprblender.utils.logging has functions similar to logging. It also includes callable class Log which provides simplified interface to do logging.Example:from rprblender.utils import logginglog = logging.Log(tag='export.mesh')

log("sync", mesh, obj)

e.g.logging.debug(*argv, tag) where argv is what is printed(same as with print) and tag is string suffix for logger name, for filteringso thatlogging.limit_log(name, level_show_always) will allow to filter out what doesn't start withname(expect levels equal or abovelevel_show_always)

configdev.py(loaded very early) can be used to include code likelimit_log to configure your session

from .utils import logginglogging.limit_log('default', logging.DEBUG)from . import configconfig.pyrpr_log_calls = True #  log all Core function calls to console, can be VERY useful

• Visual Studio has really nice(and working) mixed(python and C stack) debugging - recommended!
• Blender debug - it's easiest tobuild Blender in Release or RelWithDebInfo(and add#pragma optimize( "", off ))
• Debug in PyCharm -import pydevd; pydevd.settrace('localhost', port=52128, stdoutToServer=True, stderrToServer=True, suspend=False)

• Move toBlenderPkg directory
• Runbuild_osx-arm64.sh for Mac for MX processors
• Tag the commit in the build folder's ProRenderBlenderPlugingit tag builds/x.y.zz
• Push the taggit push --tags
• Increase version insrc/rprblender/__init__.py

Getpycharm-blender. See instructions on the github page or, in short,runpypredef_gen.py from Blender itself or using command line, e.g.blender --python pypredef_gen.py,add "pypredef" folder path that this script creates to you PyCharm Interpreter paths, find paths settings underFile | Settings(or Default Settings) | Project Interpreter

Increase max file size for Pycharm intellisence(bpy.py generated is huge), go toHelp | Edit Custom VM Options and add the following line:

-Didea.max.intellisense.filesize=5000000

Restart PyCharm

Install python extension in Visual Studio

Create new project from existing python code: Menu -> File -> New -> Project -> Python tab -> From Existing Python Code

Add following Search Paths to project:

• rprblender\support
• <path to Blender 2.93>\2.93\scripts\modules # path where to Blender's modules
• <path to "PyCharm->Blender api intellisense support">

Get Blender-VScode-Debugger plugin for Blender fromhttps://github.com/Barbarbarbarian/Blender-VScode-Debugger

Install plugin Blender_VScode_Debugger.py in Blender: Menu -> File -> User Preferences -> Click "Install Add-on from file" -> Select Blender_VScode_Debugger.py -> Click "Install Add-on from file". New adddon "Development: Debugger for Visual Code" should be appeared

Enable "Development: Debugger for Visual Code" addon. Select "Path to PTVSD module": C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Extensions\Microsoft\Python Tools for Visual Studio\2.2\

Click "Save User Settings"

In Blender: press -> in appeared dialog type "debug" -> select "Connect to Visual Studio Code Debugger"

In VS: Menu -> Debug -> Attach To Process -> select Transport "Python remote (ptvsd)" -> type in Qualifier "my_secret@localhost:3000" -> click Refresh: process Blender.exe "tcp://localhost:3000" should be appeared -> select process -> click Attach

Remote debugging connection established.

The version number should be updated when a new plugin is released. This is done by editing the version fieldof the bl_info structure in thesrc/rprblender/__init__.py file. Currently a build script will update the buildnumber when checkins happen to the master branch. So it is only necessary to update the major or minor numberwhen required.