Skip to content

KDGpu::Texture

Module: Public API

Texture.

#include <texture.h>

Public Functions

Name
Texture()
~Texture()
Texture(Texture && other)
Texture & operator=(Texture && other)
Texture(const Texture & ) =delete
Texture & operator=(const Texture & ) =delete
const Handle< Texture_t > & handle() const
bool isValid() const
operator Handle< Texture_t >() const
TextureView createView(const TextureViewOptions & options =TextureViewOptions()) const
void * map()
void unmap()
void hostLayoutTransition(const HostLayoutTransition & transition)
void copyHostMemoryToTexture(const HostMemoryToTextureCopy & copy)
void copyTextureToHostMemory(const TextureToHostMemoryCopy & copy)
void copyTextureToTextureHost(const TextureToTextureCopyHost & copy)
SubresourceLayout getSubresourceLayout(const TextureSubresource & subresource =TextureSubresource()) const
bool generateMipMaps(Device & device, Queue & transferQueue, const Handle< Texture_t > & sourceTexture, const TextureOptions & options, TextureLayout oldLayout, TextureLayout newLayout =TextureLayout::Undefined)
Generate mipmaps by copying from another texture and then generating mipmaps for this texture.
bool generateMipMaps(Device & device, Queue & transferQueue, const TextureOptions & options, TextureLayout oldLayout, TextureLayout newLayout =TextureLayout::Undefined)
Generate mipmaps for this texture.
MemoryHandle externalMemoryHandle() const
uint64_t drmFormatModifier() const

Friends

Name
class Swapchain
class Device
class VulkanGraphicsApi
KDGPU_EXPORT bool operator==(const Texture & a, const Texture & b)

Public Functions Documentation

function Texture

1
Texture()

function ~Texture

1
~Texture()

function Texture

1
2
3
Texture(
    Texture && other
)

function operator=

1
2
3
Texture & operator=(
    Texture && other
)

function Texture

1
2
3
Texture(
    const Texture & 
) =delete

function operator=

1
2
3
Texture & operator=(
    const Texture & 
) =delete

function handle

1
inline const Handle< Texture_t > & handle() const

function isValid

1
inline bool isValid() const

function operator Handle< Texture_t >

1
inline operator Handle< Texture_t >() const

function createView

1
2
3
TextureView createView(
    const TextureViewOptions & options =TextureViewOptions()
) const

function map

1
void * map()

function unmap

1
void unmap()

function hostLayoutTransition

1
2
3
void hostLayoutTransition(
    const HostLayoutTransition & transition
)

function copyHostMemoryToTexture

1
2
3
void copyHostMemoryToTexture(
    const HostMemoryToTextureCopy & copy
)

function copyTextureToHostMemory

1
2
3
void copyTextureToHostMemory(
    const TextureToHostMemoryCopy & copy
)

function copyTextureToTextureHost

1
2
3
void copyTextureToTextureHost(
    const TextureToTextureCopyHost & copy
)

function getSubresourceLayout

1
2
3
SubresourceLayout getSubresourceLayout(
    const TextureSubresource & subresource =TextureSubresource()
) const

function generateMipMaps

1
2
3
4
5
6
7
8
bool generateMipMaps(
    Device & device,
    Queue & transferQueue,
    const Handle< Texture_t > & sourceTexture,
    const TextureOptions & options,
    TextureLayout oldLayout,
    TextureLayout newLayout =TextureLayout::Undefined
)

Generate mipmaps by copying from another texture and then generating mipmaps for this texture.

Parameters:

  • device KDGpuDevice
  • transferQueue KDGpu Transfer Queue
  • sourceTexture Texture to copy/blit from when creating the mipmaps
  • options Texture Options for the target texture
  • oldLayout Transitioning from this layout
  • newLayout Transitioning to this layout when the mip map creation is done

Return: true when successful

function generateMipMaps

1
2
3
4
5
6
7
bool generateMipMaps(
    Device & device,
    Queue & transferQueue,
    const TextureOptions & options,
    TextureLayout oldLayout,
    TextureLayout newLayout =TextureLayout::Undefined
)

Generate mipmaps for this texture.

Parameters:

  • device KDGpuDevice
  • transferQueue KDGpu Transfer Queue
  • options Texture Options for the target texture
  • oldLayout Transitioning from this layout
  • newLayout Transitioning to this layout when the mip map creation is done

Return: true when successful

function externalMemoryHandle

1
MemoryHandle externalMemoryHandle() const

function drmFormatModifier

1
uint64_t drmFormatModifier() const

Friends

friend Swapchain

1
2
3
friend class Swapchain(
    Swapchain 
);

friend Device

1
2
3
friend class Device(
    Device 
);

friend VulkanGraphicsApi

1
2
3
friend class VulkanGraphicsApi(
    VulkanGraphicsApi 
);

friend operator==

1
2
3
4
5
friend KDGPU_EXPORT bool operator==(
    const Texture & a,

    const Texture & b
);

Updated on 2025-11-02 at 00:01:42 +0000