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

Agree on a list of abbreviations for variable names and add it to the docs #464

Open
IAmNotHanni opened this issue Apr 18, 2022 · 0 comments
Labels
cat:documentation documentation

Comments

@IAmNotHanni
Copy link
Member

IAmNotHanni commented Apr 18, 2022

Is your feature request related to a problem?

There are inconsistencies in variable naming in the code.

Description

(keep in alphabetical order)

Variable name Abbreviation
allocation alloc
application app
attachment(s) attch(s)
attribute(s) attr(s)
begin info bi
bounding box bbox
bounding sphere bsphere
buffer(s) buf(s)
capabilities caps
command(s) cmd(s)
configuration config
constant const
coordiantes coords
create info ci
dependencies deps
descriptor desc
destination dst
dynamic dyn
extension ext
feature(s) feat(s)
format fmt
framebuffer(s) framebuf(s)
function func
image img
image_view img_view
instance inst
maximum max
memory mem
minimum min
object obj
origin orig
preferred pref
properties props
queue family index qfam_index
rasterization rast
reference ref
resource res
state create info sci
source src
subresource subres
vulkan memory allocator vma
vulkan vk
window wnd

Parameter name suggestions

Variable name Proposed name
VkInstance inst
VkPhysicalDevice gpu
VkSurfaceKHR surface

Not abbreviated (also not in plural form)

Not abbreviated name
action
allocator
assembly
barrier
binding
button
candidate
center
color
copy
count
current
data
device
engine
extent
fence
height
index
intersection
layout
module
monitor
name
offset
renderpass
pipeline
pipeline_layout
queue
ray
region
sample
sampler
scissor
semaphore
selected
settings
shader
size
stack
stage
sub
subpass
surface
swapchain
texture
timeout
transfer
triangle
version
viewport
width
zoom
@github-actions github-actions bot added the org:triage labels have to be specified or checked label Apr 18, 2022
@IAmNotHanni IAmNotHanni removed the org:triage labels have to be specified or checked label Apr 18, 2022
@IceflowRE IceflowRE added the cat:documentation documentation label Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:documentation documentation
Projects
None yet
Development

No branches or pull requests

2 participants