pyktx.ktx_texture module
- class pyktx.ktx_texture.KtxTexture(ptr: c_ulong)[source]
Bases:
objectBase class representing a texture.
ktxTextures should be created only by one of the static factory methods, and these fields should be considered read-only.
- property base_depth: int
Depth of the texture’s base level.
- property base_height: int
Height of the texture’s base level.
- property base_width: int
Width of the texture’s base level.
- property class_id: int
Identify the class type. 1 for KtxTexture1, 2 for KtxTexture2.
- property data_size: int
The total size of the texture image data in bytes.
- property data_size_uncompressed: int
Byte length of the texture’s uncompressed image data.
- property element_size: int
The element size of the texture’s images.
- property generate_mipmaps: bool
If mipmaps should be generated for the texture when uploading to graphics APIs.
- image_offset(level: int, layer: int, face_slice: int) int[source]
Find the offset of an image within a ktxTexture’s image data.
As there is no such thing as a 3D cubemap we make the 3rd location parameter do double duty.
- image_size(level: int) int[source]
Calculate & return the size in bytes of an image at the specified mip level.
For arrays, this is the size of layer, for cubemaps, the size of a face and for 3D textures, the size of a depth slice.
The size reflects the padding of each row to KTX_GL_UNPACK_ALIGNMENT.
- property is_array: bool
true if the texture is an array texture, i.e, a GL_TEXTURE_*_ARRAY target is to be used.
- property is_compressed: bool
If the texture’s format is a block compressed format.
- property is_cubemap: bool
True if the texture is a cubemap or cubemap array.
- property kv_data: KtxHashList
The metadata stored in the texture as a hash-list.
This is not available if SKIP_KVDATA_BIT was used in the create-flag bits.
- property kv_data_raw: create_string_buffer | None
The raw KV data buffer.
This is available only if RAW_KVDATA_BIT was used in create-flag bits.
- property num_dimensions: int
1, 2 or 3.
- Type:
Number of dimensions in the texture
- property num_faces: int
6 for cube maps, 1 otherwise.
- Type:
Number of faces
- property num_levels: int
Number of mip levels in the texture.
- row_pitch(level: int) int[source]
Return pitch between rows of a texture image level in bytes.
For uncompressed textures the pitch is the number of bytes between rows of texels. For compressed textures it is the number of bytes between rows of blocks. The value is padded to GL_UNPACK_ALIGNMENT, if necessary. For all currently known compressed formats padding will not be necessary.
- set_image_from_memory(level: int, layer: int, face_slice: int, data: bytes)[source]
Set image for level, layer, faceSlice from an image in memory.
Uncompressed images in memory are expected to have their rows tightly packed as is the norm for most image file formats. The copied image is padded as necessary to achieve the KTX-specified row alignment. No padding is done if the ktxTexture’s is_compressed field is true. Level, layer, face_slice rather than offset are specified to enable some validation.