# {py:mod}`simvx.graphics.gpu.memory`

```{py:module} simvx.graphics.gpu.memory
```

```{autodoc2-docstring} simvx.graphics.gpu.memory
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`create_buffer <simvx.graphics.gpu.memory.create_buffer>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.create_buffer
    :summary:
    ```
* - {py:obj}`create_image <simvx.graphics.gpu.memory.create_image>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.create_image
    :summary:
    ```
* - {py:obj}`create_sampler <simvx.graphics.gpu.memory.create_sampler>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.create_sampler
    :summary:
    ```
* - {py:obj}`transition_image_layout <simvx.graphics.gpu.memory.transition_image_layout>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.transition_image_layout
    :summary:
    ```
* - {py:obj}`upload_numpy <simvx.graphics.gpu.memory.upload_numpy>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.upload_numpy
    :summary:
    ```
* - {py:obj}`begin_single_time_commands <simvx.graphics.gpu.memory.begin_single_time_commands>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.begin_single_time_commands
    :summary:
    ```
* - {py:obj}`end_single_time_commands <simvx.graphics.gpu.memory.end_single_time_commands>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.end_single_time_commands
    :summary:
    ```
* - {py:obj}`upload_image_data <simvx.graphics.gpu.memory.upload_image_data>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.upload_image_data
    :summary:
    ```
* - {py:obj}`create_indirect_buffer <simvx.graphics.gpu.memory.create_indirect_buffer>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.create_indirect_buffer
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.graphics.gpu.memory.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.__all__
    :summary:
    ```
* - {py:obj}`log <simvx.graphics.gpu.memory.log>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.memory.log
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.gpu.memory.__all__
:value: >
   ['create_buffer', 'create_image', 'create_sampler', 'transition_image_layout', 'upload_numpy', 'uplo...

```{autodoc2-docstring} simvx.graphics.gpu.memory.__all__
```

````

````{py:data} log
:canonical: simvx.graphics.gpu.memory.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.graphics.gpu.memory.log
```

````

````{py:function} create_buffer(device: typing.Any, physical_device: typing.Any, size: int, usage: int, memory_flags: int) -> tuple[typing.Any, typing.Any]
:canonical: simvx.graphics.gpu.memory.create_buffer

```{autodoc2-docstring} simvx.graphics.gpu.memory.create_buffer
```
````

````{py:function} create_image(device: typing.Any, physical_device: typing.Any, width: int, height: int, fmt: int, usage: int) -> tuple[typing.Any, typing.Any]
:canonical: simvx.graphics.gpu.memory.create_image

```{autodoc2-docstring} simvx.graphics.gpu.memory.create_image
```
````

````{py:function} create_sampler(device: typing.Any, filter_mode: int = vk.VK_FILTER_LINEAR) -> typing.Any
:canonical: simvx.graphics.gpu.memory.create_sampler

```{autodoc2-docstring} simvx.graphics.gpu.memory.create_sampler
```
````

````{py:function} transition_image_layout(device: typing.Any, queue: typing.Any, cmd_pool: typing.Any, image: typing.Any, old_layout: int, new_layout: int, aspect_mask: int = vk.VK_IMAGE_ASPECT_COLOR_BIT) -> None
:canonical: simvx.graphics.gpu.memory.transition_image_layout

```{autodoc2-docstring} simvx.graphics.gpu.memory.transition_image_layout
```
````

````{py:function} upload_numpy(device: typing.Any, memory: typing.Any, data: numpy.ndarray) -> None
:canonical: simvx.graphics.gpu.memory.upload_numpy

```{autodoc2-docstring} simvx.graphics.gpu.memory.upload_numpy
```
````

````{py:function} begin_single_time_commands(device: typing.Any, cmd_pool: typing.Any) -> typing.Any
:canonical: simvx.graphics.gpu.memory.begin_single_time_commands

```{autodoc2-docstring} simvx.graphics.gpu.memory.begin_single_time_commands
```
````

````{py:function} end_single_time_commands(device: typing.Any, queue: typing.Any, cmd_pool: typing.Any, cmd: typing.Any) -> None
:canonical: simvx.graphics.gpu.memory.end_single_time_commands

```{autodoc2-docstring} simvx.graphics.gpu.memory.end_single_time_commands
```
````

````{py:function} upload_image_data(device: typing.Any, physical_device: typing.Any, queue: typing.Any, cmd_pool: typing.Any, pixels: numpy.ndarray, width: int, height: int, fmt: int = vk.VK_FORMAT_R8G8B8A8_UNORM) -> tuple[typing.Any, typing.Any]
:canonical: simvx.graphics.gpu.memory.upload_image_data

```{autodoc2-docstring} simvx.graphics.gpu.memory.upload_image_data
```
````

````{py:function} create_indirect_buffer(device: typing.Any, physical_device: typing.Any, draw_count: int) -> tuple[typing.Any, typing.Any]
:canonical: simvx.graphics.gpu.memory.create_indirect_buffer

```{autodoc2-docstring} simvx.graphics.gpu.memory.create_indirect_buffer
```
````