Promote sprite depth examples from experimental to main #2434

pushfoo · 2024-10-24T08:48:21Z

Stop trying to set the window's read-only clock value
Convert them to the new View example style
Add entries for them in the examples listing

* Stop trying to set the window's read-only clock value * Fix annoying indent on list at top of comments

DragonMoffon

The window has a depth buffer by default, and spritelists innately support depth testing so this should be moved to examples

arcade/experimental/sprite_depth_cosine.py

* Make the example subclass view * Use the same style found in other examples * Grab the context locally

alejcas · 2024-10-24T09:27:27Z

Seems like this line is wrong:

if self.use_depth:

You moved use_depth to the window so the line should check:

if self.window.use_depth:

Anyway I don't understand why you moved that attribute to the window. Just leave it in the view...no?

alejcas · 2024-10-24T09:29:51Z

Seems like this line is wrong:

if self.use_depth:

You moved use_depth to the window so the line should check:

if self.window.use_depth:

Anyway I don't understand why you moved that attribute to the window. Just leave it in the view...no?

I think this is what's wrong:

window.use_depth = not window.use_depth

* Convert to View style * Make bg / clear color a Color defined at the top of the file * Use WINDOW_TITLE, WINDOW_WIDTH, and WINDOW_HEIGHT constants

* Add a screenshot for the example page and example gallery * Add an .rst file to reference the code and example * Add the .rst file to the examples gallery

* Add a screenshot for the page and gallery * Add an example .rst file for it * Add an entry in the examples page

pushfoo · 2024-10-24T09:59:47Z

@alejcas fixed

arcade/examples/depth_of_field.py

arcade/examples/sprite_depth_cosine.py

einarf · 2024-10-25T17:55:33Z

The reason it wasn't moved into examples was a lingering issue related to the depth range. As far as I know the depth range set in the ortho projection is [-1.0, 1.0] defining the depth that can be set in the sprite's geometry.

We could possibly change to to [-1, 100] to give the user a more reasonable range to work with? If the sprite depth is set outside this range it risks being clipped in primitive assembly not appearing.

Including a new reasonable depth range would make things a bit more cleaner?

einarf · 2024-10-25T18:05:19Z

It seems @DragonMoffon changed the range to [-100, 100] so we should make sure to mention this range in the example and take advantage of this range if that's not already in place. Seems it was modified a bit from the original -1 to 1 range.

The default depth range in arcade is -100 (near plane) / 100 (far plane). Higher value is further away from the camera.

pushfoo · 2024-10-25T18:08:37Z

Can we add default near and far constants to make this more legible?

einarf · 2024-10-25T18:26:19Z

For now I think it's enough to just mention the default range.

DragonMoffon · 2024-10-26T00:07:02Z

I didn't actually choose this range myself. There was definitely a code snippet in Arcade that I based it on. I feel like it was the internal matrix gen, but it might have been one of the gl tutorials.

In any case, in the depth example, it should probably be mentioned since it's directly settable in Camer2D's init

DragonMoffon

One last, very pedantic, change. Im otherwise happy for it to be merged.

arcade/examples/sprite_depth_cosine.py

pushfoo · 2024-10-26T02:25:10Z

Added doc about near / far clipping
Changed time phrasing to be lessspecific to American / Hemmingway style
Centralized near / far defaults from a single source of truth

pushfoo · 2024-10-26T02:32:57Z

"yeah looks good" - DragonMoffon (Discord)

Fix sprite depth example clock and style

7f2d09f

* Stop trying to set the window's read-only clock value * Fix annoying indent on list at top of comments

pushfoo requested a review from DragonMoffon October 24, 2024 08:48

DragonMoffon requested changes Oct 24, 2024

View reviewed changes

arcade/experimental/sprite_depth_cosine.py Outdated Show resolved Hide resolved

pushfoo added 3 commits October 24, 2024 05:09

Convert sprite_depth_cosine.py to use Views style

fd62b57

* Make the example subclass view * Use the same style found in other examples * Grab the context locally

Move sprite depth cosine example

077f8af

Fix run string at top of file

13619ca

pushfoo added 7 commits October 24, 2024 05:31

Convert depth of field example to View style

217fd32

* Convert to View style * Make bg / clear color a Color defined at the top of the file * Use WINDOW_TITLE, WINDOW_WIDTH, and WINDOW_HEIGHT constants

Move depth of field example into main examples

a1b3d8a

Update run string at top of file

6c2205c

Add sprite_depth_buffer to the examples page

219ffcd

* Add a screenshot for the example page and example gallery * Add an .rst file to reference the code and example * Add the .rst file to the examples gallery

Add depth_of_field.py to the examples gallery

46c2a39

* Add a screenshot for the page and gallery * Add an example .rst file for it * Add an entry in the examples page

Fix DoF example run line

5efb6a1

Fix issue jans pointed out

09e2e97

pushfoo added 3 commits October 24, 2024 06:01

Remove unused assignment

4a300e2

Use black bg for sprite_depth_cosine screenshot

9c9447c

Put example tiles in appropriate sections based on feedback

a3a44b0

pushfoo changed the title ~~Fix sprite depth example clock and style~~ Promote sprite depth examples from experimental to main Oct 24, 2024

Move the sprite depth example to the Sprite Properties heading

3a6dca2

pushfoo requested a review from DragonMoffon October 24, 2024 10:56

DragonMoffon requested changes Oct 25, 2024

View reviewed changes

arcade/examples/depth_of_field.py Outdated Show resolved Hide resolved

arcade/examples/depth_of_field.py Outdated Show resolved Hide resolved

arcade/examples/sprite_depth_cosine.py Outdated Show resolved Hide resolved

arcade/examples/sprite_depth_cosine.py Outdated Show resolved Hide resolved

pushfoo added 2 commits October 25, 2024 12:41

Fix comments and naming conventions per GitHub review

88ad66b

Tweak phrasing

d8758be

pushfoo requested a review from DragonMoffon October 25, 2024 16:44

DragonMoffon approved these changes Oct 26, 2024

View reviewed changes

arcade/examples/sprite_depth_cosine.py Outdated Show resolved Hide resolved

pushfoo added 4 commits October 25, 2024 20:32

Update phrasing further

6329297

Centralize and document near/far defaults a bit

44716e1

Linter

8514d52

More linter

111f519

pushfoo merged commit e554b02 into development Oct 26, 2024
9 checks passed

pushfoo deleted the sprite-depth-clock-fix branch October 26, 2024 18:25

Promote sprite depth examples from experimental to main #2434

Promote sprite depth examples from experimental to main #2434

Uh oh!

Conversation

pushfoo commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DragonMoffon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alejcas commented Oct 24, 2024

Uh oh!

alejcas commented Oct 24, 2024

Uh oh!

pushfoo commented Oct 24, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

einarf commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

einarf commented Oct 25, 2024

Uh oh!

pushfoo commented Oct 25, 2024

Uh oh!

einarf commented Oct 25, 2024

Uh oh!

DragonMoffon commented Oct 26, 2024

Uh oh!

DragonMoffon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pushfoo commented Oct 26, 2024

Uh oh!

pushfoo commented Oct 26, 2024

Uh oh!

Uh oh!

Uh oh!

pushfoo commented Oct 24, 2024 •

edited

Loading

einarf commented Oct 25, 2024 •

edited

Loading