PyAPI: Allow prop collection raw array read access for non-editable props #114063

Merged
Bastien Montagne merged 4 commits from Mysteryem/blender:prop_collection_raw_read_access into main 2023-11-06 15:51:16 +01:00
Member

Non-editable prop collection items would always fall back to the slower
loop in rna_raw_access.

This patch changes RNA_property_collection_raw_array to only fail with
non-editable items when intending to set values, allowing for the faster
raw array access to occur when reading values in rna_raw_access.

This brings the Python API bpy_prop_collection.foreach_get performance
of Mesh.vertex_normals/polygon_normals/corner_normals up to the same
speed as generic FLOAT_VECTOR attributes with the same domains.

Given a mesh with 393216 corners:

Using foreach_get with the "vector" prop and a compatible buffer object:

  • Corner vector attribute: ~0.9ms
  • Corner normals (before): ~7.9ms
  • Corner normals (after): ~0.9ms

Using foreach_get with the "vector" prop and a Python list:

  • Corner vector attribute: ~11.0ms
  • Corner normals (before): ~18.0ms
  • Corner normals (after): ~11.0ms
Non-editable prop collection items would always fall back to the slower loop in rna_raw_access. This patch changes RNA_property_collection_raw_array to only fail with non-editable items when intending to set values, allowing for the faster raw array access to occur when reading values in rna_raw_access. This brings the Python API bpy_prop_collection.foreach_get performance of Mesh.vertex_normals/polygon_normals/corner_normals up to the same speed as generic FLOAT_VECTOR attributes with the same domains. Given a mesh with 393216 corners: Using foreach_get with the "vector" prop and a compatible buffer object: - Corner vector attribute: ~0.9ms - Corner normals (before): ~7.9ms - Corner normals (after): ~0.9ms Using foreach_get with the "vector" prop and a Python list: - Corner vector attribute: ~11.0ms - Corner normals (before): ~18.0ms - Corner normals (after): ~11.0ms
Thomas Barlow added 2 commits 2023-10-23 15:19:14 +02:00
886d92bcb1 PyAPI: Allow prop collection raw array read access for non-editable props
Non-editable prop collection items would always fall back to the slower
loop in rna_raw_access.

This patch changes RNA_property_collection_raw_array to only fail with
non-editable items when intending to set values, allowing for the faster
raw array access to occur when intending to read values.

This brings the Python API bpy_prop_collection.foreach_get performance
of Mesh.vertex_normals/polygon_normals/corner_normals up to the same
speed as generic FLOAT_VECTOR attributes with the same domains.

Given a mesh with 393216 corners:
Using foreach_get with the "vector" prop and a compatible buffer object:
- Corner vector attribute: ~0.9ms
- Corner normals (before): ~7.9ms
- Corner normals (after):  ~0.9ms
Using foreach_get with the "vector" prop and a Python list:
- Corner vector attribute: ~11.0ms
- Corner normals (before): ~18.0ms
- Corner normals (after):  ~11.0ms
Iliya Katushenock added this to the Python API project 2023-10-23 15:21:09 +02:00
Iliya Katushenock added the
Module
Modeling
label 2023-10-23 15:21:14 +02:00
Bastien Montagne approved these changes 2023-10-30 16:27:26 +01:00
Bastien Montagne left a comment
Owner

Nice find! Besides picky note below, LGTM, thanks!

Nice find! Besides picky note below, LGTM, thanks!
@ -456,2 +454,2 @@
PropertyRNA *itemprop,
RawArray *array);
int RNA_property_collection_raw_array(
PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, int set, RawArray *array);

Would rather use bool when adding new boolean parameters. usage of int for these is only for historical reasons, and (still) needs to be cleaned up...

Would rather use `bool` when adding new boolean parameters. usage of `int` for these is only for historical reasons, and (still) needs to be cleaned up...
Bastien Montagne removed this from the Python API project 2023-10-30 16:27:38 +01:00
Bastien Montagne added
Module
Core
Interest
Modeling
and removed
Module
Modeling
labels 2023-10-30 16:27:53 +01:00
Bastien Montagne added the
Interest
Python API
label 2023-10-30 16:30:02 +01:00
Thomas Barlow added 1 commit 2023-10-30 18:05:32 +01:00

@blender-bot build

@blender-bot build

@blender-bot build

@blender-bot build
Thomas Barlow added 1 commit 2023-11-06 14:36:25 +01:00
Author
Member

I haven't been able to get the test_load_exr failure on this PR branch at all, but I did get it once on another branch that was created from main at the same point in time, so maybe it was just a bad point in time to create this PR branch at. I've merged main into this PR branch now, so hopefully that fixes the test failure (still has not failed for me when running the tests locally).

I haven't been able to get the test_load_exr failure on this PR branch at all, but I did get it once on another branch that was created from `main` at the same point in time, so maybe it was just a bad point in time to create this PR branch at. I've merged `main` into this PR branch now, so hopefully that fixes the test failure (still has not failed for me when running the tests locally).

I don't think that test failure was related to this patch indeed.

Will re-run it just in case.

@blender-bot build

I don't think that test failure was related to this patch indeed. Will re-run it just in case. @blender-bot build

@blender-bot build linux

@blender-bot build linux
Bastien Montagne approved these changes 2023-11-06 15:48:58 +01:00
Bastien Montagne merged commit 9956ef4622 into main 2023-11-06 15:51:16 +01:00
Bastien Montagne deleted branch prop_collection_raw_read_access 2023-11-06 15:51:18 +01:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#114063
No description provided.