Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation #50

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

SigmaKlim
Copy link

@SigmaKlim SigmaKlim commented Apr 17, 2024

engine/drv/drv3d_DX12

Commented files (10):

  • bitfield.h
  • byte_units.h
  • d3d12_d3d_translation.h
  • d3d12_d3d_debug_names.h
  • d3d12_d3d_error_handling.h
  • d3d12_d3d_utils, dynamic_array.h
  • half_float.h
  • typed_bit_set.h
  • util.h

prog/dagorInclude/3d

Commented files (8):

  • dag_createTex.h
  • dag_d3dResource.h
  • dag_drv3d.h
  • dag_drv3d_pc.h
  • dag_drvDecl.h
  • dag_lockSBuffer.h
  • dag_resId.h
  • dag_ringDynBuf.h

Nikita Yastrebov added 3 commits April 17, 2024 12:01
Commented files: bitfield, byte_units, d3d12_d3d_translation, d3d12_d3d_debug_names, d3d12_d3d_error_handling, d3d12_d3d_utils, dynamic_array, half_float, typed_bit_set, util - (10)
Commented files: dag_createtex.h, dag_d3dResource.h, dag_drv3d.h, dag_ringDynBuf.h
Files: dag_createTex.h, dag_d3dResource.h, dag_drv3d.h, dag_drv3d_pc.h, dag_drvDecl.h, dag_lockSBuffer.h, dag_resId.h, dag_ringDynBuf.h
@SigmaKlim SigmaKlim changed the title engine/drv/drv3d_DX12 #1 documentation Jun 10, 2024
Nikita Yastrebov and others added 2 commits June 24, 2024 14:19
Commented files: dag_resId.h, dag_resMgr.h, dag_resPtr.h - all about resource management
@AlexandrShcherbakov
Copy link

Hello!

Unfortunately, your PR is not mergeable currently since a lot of changes in files with the D3D API were made.
Regarding documentation for DX12 inner classes and methods, we are not able to support it up to date currently, since D3D API documentation is more important and it's still in progress.
Also, some statements in the PR are incorrect. For instance, here: dcc2793#diff-cf89688594c8803cdbd914a42f6014773d77384ed775d7df436b3b5c436c6f67R300
The statement "The buffer is designed as stream output" is wrong. This buffer is filled on the CPU side.

I suggest you make smaller PRs for the latest version of the engine, so it will be simpler to review and merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants