vulky - a pythonian vulkan facade

Welcome to vulky documentation

Getting started

• Installation
• Usage

API Reference

• Types
  • AABBCollection
    • AABBCollection.append()
    • AABBCollection.get_collection_type()
  • ADS
  • ADSNodeType
    • ADSNodeType.AABB
    • ADSNodeType.INSTANCE
    • ADSNodeType.NONE
    • ADSNodeType.TRIANGLES
  • AddressMode
    • AddressMode.BORDER
    • AddressMode.CLAMP_EDGE
    • AddressMode.NONE
    • AddressMode.REPEAT
  • BorderColor
    • BorderColor.NONE
    • BorderColor.OPAQUE_BLACK_FLOAT
    • BorderColor.OPAQUE_BLACK_INT
    • BorderColor.OPAQUE_WHITE_FLOAT
    • BorderColor.OPAQUE_WHITE_INT
    • BorderColor.TRANSPARENT_BLACK_FLOAT
    • BorderColor.TRANSPARENT_BLACK_INT
  • Buffer
    • Buffer.memory
    • Buffer.size
    • Buffer.slice()
  • BufferUsage
    • BufferUsage.INDEX
    • BufferUsage.NONE
    • BufferUsage.RAYTRACING_ADS
    • BufferUsage.RAYTRACING_RESOURCE
    • BufferUsage.SHADER_TABLE
    • BufferUsage.STAGING
    • BufferUsage.STORAGE
    • BufferUsage.UNIFORM
    • BufferUsage.VERTEX
  • CommandManager
    • CommandManager.freeze()
    • CommandManager.get_queue_required()
    • CommandManager.image_barrier()
    • CommandManager.is_closed()
    • CommandManager.is_frozen()
    • CommandManager.use()
  • CompareOp
    • CompareOp.ALWAYS
    • CompareOp.EQUAL
    • CompareOp.GREATER
    • CompareOp.GREATER_OR_EQUAL
    • CompareOp.LESS
    • CompareOp.LESS_OR_EQUAL
    • CompareOp.NEVER
    • CompareOp.NONE
    • CompareOp.NOT_EQUAL
  • ComputeManager
    • ComputeManager.bind()
    • ComputeManager.clear_buffer()
    • ComputeManager.clear_color()
    • ComputeManager.clear_depth_stencil()
    • ComputeManager.dispatch_groups()
    • ComputeManager.dispatch_threads()
    • ComputeManager.dispatch_threads_1D()
    • ComputeManager.dispatch_threads_2D()
    • ComputeManager.get_queue_required()
    • ComputeManager.set_pipeline()
    • ComputeManager.update_constants()
    • ComputeManager.update_sets()
  • CopyManager
    • CopyManager.copy()
    • CopyManager.get_queue_required()
  • DescriptorSet
    • DescriptorSet.update()
  • DescriptorSetCollection
  • DescriptorType
    • DescriptorType.COMBINED_IMAGE
    • DescriptorType.NONE
    • DescriptorType.SAMPLED_IMAGE
    • DescriptorType.SAMPLER
    • DescriptorType.SCENE_ADS
    • DescriptorType.STORAGE_BUFFER
    • DescriptorType.STORAGE_IMAGE
    • DescriptorType.UNIFORM_BUFFER
  • Filter
    • Filter.LINEAR
    • Filter.NONE
    • Filter.POINT
  • Format
    • Format.DEPTH_STENCIL
    • Format.FLOAT
    • Format.INT
    • Format.IVEC2
    • Format.IVEC3
    • Format.IVEC4
    • Format.NONE
    • Format.PRESENTER
    • Format.UINT
    • Format.UINT_BGRA_STD
    • Format.UINT_BGRA_UNORM
    • Format.UINT_RGB
    • Format.UINT_RGBA
    • Format.UINT_RGBA_STD
    • Format.UINT_RGBA_UNORM
    • Format.UVEC2
    • Format.UVEC3
    • Format.UVEC4
    • Format.VEC2
    • Format.VEC3
    • Format.VEC4
  • FrameBuffer
  • GPUPtr
    • GPUPtr.flush()
    • GPUPtr.invalidate()
    • GPUPtr.mark_as_dirty()
    • GPUPtr.update_mode()
  • GTensorMeta
  • GeometryCollection
    • GeometryCollection.get_collection_type()
  • GraphicsManager
    • GraphicsManager.bind_index_buffer()
    • GraphicsManager.bind_vertex_buffer()
    • GraphicsManager.blit_image()
    • GraphicsManager.dispatch_indexed_primitives()
    • GraphicsManager.dispatch_primitives()
    • GraphicsManager.get_queue_required()
    • GraphicsManager.set_framebuffer()
  • GraphicsPipeline
    • GraphicsPipeline.attach()
    • GraphicsPipeline.create_framebuffer()
    • GraphicsPipeline.vertex()
    • GraphicsPipeline.vertex_binding()
  • Image
    • Image.as_readonly()
    • Image.compute_dimension()
    • Image.element_size()
    • Image.get_array_count()
    • Image.get_image_dimension()
    • Image.get_mip_count()
    • Image.numel()
    • Image.size
    • Image.slice_array()
    • Image.slice_mips()
    • Image.subresource()
    • Image.subresource_footprint()
  • ImageType
    • ImageType.NONE
    • ImageType.TEXTURE_1D
    • ImageType.TEXTURE_2D
    • ImageType.TEXTURE_3D
  • ImageUsage
    • ImageUsage.ANY
    • ImageUsage.DEPTH_STENCIL
    • ImageUsage.NONE
    • ImageUsage.RENDER_TARGET
    • ImageUsage.SAMPLED
    • ImageUsage.STORAGE
    • ImageUsage.TRANSFER
  • Layout
    • Layout.fix_shape()
    • Layout.from_aabb()
    • Layout.from_description()
    • Layout.from_format()
    • Layout.from_instance()
    • Layout.from_instance2()
    • Layout.from_structure()
    • Layout.is_scalar_type()
    • Layout.scalar_size()
    • Layout.set_24bit_from_int()
  • LayoutAlignment
    • LayoutAlignment.COMPACT
    • LayoutAlignment.SCALAR
    • LayoutAlignment.STD430
  • MemoryLocation
    • MemoryLocation.CPU
    • MemoryLocation.GPU
    • MemoryLocation.NONE
  • MipMapMode
    • MipMapMode.LINEAR
    • MipMapMode.NONE
    • MipMapMode.POINT
  • ObjectBuffer
    • ObjectBuffer.update_gpu()
  • ObjectBufferAccessor
    • ObjectBufferAccessor.references()
  • Pipeline
    • Pipeline.close()
    • Pipeline.create_descriptor_set_collection()
    • Pipeline.is_closed()
    • Pipeline.layout()
    • Pipeline.load_shader()
    • Pipeline.load_shader_from_source()
    • Pipeline.shader_stages()
  • PipelineType
    • PipelineType.COMPUTE
    • PipelineType.GRAPHICS
    • PipelineType.NONE
    • PipelineType.RAYTRACING
  • PresenterMode
    • PresenterMode.NONE
    • PresenterMode.OFFLINE
    • PresenterMode.WINDOW
  • QueueType
    • QueueType.COMPUTE
    • QueueType.COPY
    • QueueType.GRAPHICS
    • QueueType.NONE
    • QueueType.RAYTRACING
  • RTProgram
    • RTProgram.active_raygen_slice()
    • RTProgram.select_generation()
    • RTProgram.set_callable()
    • RTProgram.set_generation()
    • RTProgram.set_hit_group()
    • RTProgram.set_miss()
  • RaytracingManager
    • RaytracingManager.build_ads()
    • RaytracingManager.dispatch_rays()
    • RaytracingManager.get_queue_required()
    • RaytracingManager.update_ads()
  • RaytracingPipeline
    • RaytracingPipeline.create_rt_callable_group()
    • RaytracingPipeline.create_rt_gen_group()
    • RaytracingPipeline.create_rt_hit_group()
    • RaytracingPipeline.create_rt_miss_group()
    • RaytracingPipeline.create_rt_program()
    • RaytracingPipeline.stack_size()
  • Resource
    • Resource.clear()
    • Resource.cpu_ptr
    • Resource.cuda_ptr
    • Resource.device_ptr
    • Resource.is_ads
    • Resource.is_buffer
    • Resource.is_image
    • Resource.is_on_cpu
    • Resource.is_on_gpu
    • Resource.load()
    • Resource.save()
    • Resource.size
  • Sampler
  • ShaderHandler
  • ShaderStage
    • ShaderStage.COMPUTE
    • ShaderStage.FRAGMENT
    • ShaderStage.GEOMETRY
    • ShaderStage.NONE
    • ShaderStage.RT_ANY_HIT
    • ShaderStage.RT_CALLABLE
    • ShaderStage.RT_CLOSEST_HIT
    • ShaderStage.RT_GENERATION
    • ShaderStage.RT_INTERSECTION_HIT
    • ShaderStage.RT_MISS
    • ShaderStage.VERTEX
  • StructuredBuffer
    • StructuredBuffer.map()
  • StructuredBufferAccess
    • StructuredBufferAccess.build_accessor()
  • StructuredTensor
    • StructuredTensor.create()
    • StructuredTensor.create_compatible_tensor()
    • StructuredTensor.get_field()
    • StructuredTensor.get_item()
    • StructuredTensor.numpy()
    • StructuredTensor.read()
    • StructuredTensor.structure_shape()
    • StructuredTensor.tensor()
    • StructuredTensor.write()
  • TriangleCollection
    • TriangleCollection.append()
    • TriangleCollection.get_collection_type()
  • ViewTensor
    • ViewTensor.detach()
    • ViewTensor.from_blob()
    • ViewTensor.reinterpret()
    • ViewTensor.view()
  • Window
    • Window.ClientContext
    • Window.buffer()
    • Window.fps
    • Window.image()
    • Window.is_closed
    • Window.label_text()
    • Window.render_target()
    • Window.show_tensor()
    • Window.spf
    • Window.tensor()
  • aabb_collection()
  • ads_model()
  • ads_scene()
  • allow_cross_threading()
  • buffer()
  • buffer_like()
  • compile_shader_file()
  • compile_shader_source()
  • compile_shader_source_file()
  • compile_shader_sources()
  • compute_manager()
  • copy_manager()
  • create_device()
  • create_mesh()
  • depth_stencil()
  • device_manager()
  • execute_loop()
  • external_sync()
  • graphics_manager()
  • image()
  • image_1D()
  • image_2D()
  • image_3D()
  • index_buffer()
  • instance_buffer()
  • load_image()
  • load_texture()
  • load_video()
  • mat2
    • mat2.dimension
    • mat2.tensor_dtype
    • mat2.tensor_shape
  • mat3
    • mat3.dimension
    • mat3.euler_rotation()
    • mat3.inverse()
    • mat3.quaternion_rotation()
    • mat3.rotation()
    • mat3.scale()
    • mat3.tensor_dtype
    • mat3.tensor_shape
  • mat3x4
    • mat3x4.composite()
    • mat3x4.dimension
    • mat3x4.tensor_dtype
    • mat3x4.tensor_shape
    • mat3x4.transposed()
  • mat4
    • mat4.dimension
    • mat4.inv_look_at()
    • mat4.inverse()
    • mat4.look_at()
    • mat4.perspective()
    • mat4.tensor_dtype
    • mat4.tensor_shape
    • mat4.trs()
  • mat4x3
    • mat4x3.composite()
    • mat4x3.dimension
    • mat4x3.tensor_dtype
    • mat4x3.tensor_shape
    • mat4x3.transposed()
    • mat4x3.trs()
  • pipeline_compute()
  • pipeline_graphics()
  • pipeline_raytracing()
  • quit()
  • raytracing_manager()
  • render_target()
  • sampler()
  • sampler_linear()
  • save_image()
  • save_video()
  • scratch_buffer()
  • set_debug_name()
  • submit()
  • support()
  • tensor()
  • tensor_copy()
  • tensor_like()
  • tensor_to_gtensor_if_possible()
  • tensor_to_mat()
  • tensor_to_vec()
  • triangle_collection()
  • vec2
    • vec2.dimension
    • vec2.tensor_dtype
    • vec2.tensor_shape
  • vec3
    • vec3.cross()
    • vec3.dimension
    • vec3.tensor_dtype
    • vec3.tensor_shape
  • vec4
    • vec4.dimension
    • vec4.tensor_dtype
    • vec4.tensor_shape
  • vertex_buffer()
  • window()
  • wrap_gpu()