SwizContext Struct Reference

Class for context of swizzling. More...

#include <console-swizzler.h>

Public Member Functions
_SWIZ_EXTERN SwizContext *	swizNewContext ()
	Creates a new context.
_SWIZ_EXTERN void	swizFreeContext (SwizContext *context)
	Frees the memory of a context.
_SWIZ_EXTERN void	swizContextInit (SwizContext *context)
	Initialize attributes of a context.
_SWIZ_EXTERN SwizError	swizContextSetPlatform (SwizContext *context, SwizPlatform platform)
	Sets platform information to context.
_SWIZ_EXTERN SwizError	swizContextSetTextureSize (SwizContext *context, int width, int height)
	Sets width and height to context.
_SWIZ_EXTERN void	swizContextSetHasMips (SwizContext *context, int has_mips)
	Sets if textures have mipmaps or not.
_SWIZ_EXTERN SwizError	swizContextSetArraySize (SwizContext *context, int array_size)
	Sets the number of textures in a buffer.
_SWIZ_EXTERN SwizError	swizContextSetGobsHeight (SwizContext *context, int gobs_height)
	Sets the max height of GOBs blocks for switch.
_SWIZ_EXTERN SwizError	swizContextSetBlockInfo (SwizContext *context, int block_width, int block_height, int block_data_size)
	Sets block size to context.
_SWIZ_EXTERN SwizError	swizContextGetLastError (SwizContext *context)
	Gets error status of context.
_SWIZ_EXTERN uint32_t	swizGetSwizzledSize (SwizContext *context)
	Gets binary size of swizzled data.
_SWIZ_EXTERN uint32_t	swizGetUnswizzledSize (SwizContext *context)
	Gets binary size of unswizzled data.
_SWIZ_EXTERN uint8_t *	swizAllocSwizzledData (SwizContext *context)
	Allocates a buffer for swizzled data.
_SWIZ_EXTERN uint8_t *	swizAllocUnswizzledData (SwizContext *context)
	Allocates a buffer for unswizzled data.
_SWIZ_EXTERN SwizError	swizDoSwizzle (const uint8_t *data, uint8_t *swizzled, SwizContext *context)
	Swizzles a texture.
_SWIZ_EXTERN SwizError	swizDoUnswizzle (const uint8_t *data, uint8_t *unswizzled, SwizContext *context)
	Unswizzles a texture.

Detailed Description

Class for context of swizzling.

Member Function Documentation

swizAllocSwizzledData()

_SWIZ_EXTERN uint8_t * swizAllocSwizzledData

(

SwizContext *

context

)

Allocates a buffer for swizzled data.

Note

Allocated data should be freed with free().

The size of allocated data should be equal to swizGetSwizzledSize()

Parameters

context

SwizContext instance

Returns

A pointer for allocated data. Null if it got errors

swizAllocUnswizzledData()

_SWIZ_EXTERN uint8_t * swizAllocUnswizzledData

(

SwizContext *

context

)

Allocates a buffer for unswizzled data.

Note

Allocated data should be freed with free().

The size of allocated data should be equal to swizGetUnswizzledSize()

Parameters

context

SwizContext instance

Returns

A pointer for allocated data. Null if it got errors

swizContextGetLastError()

_SWIZ_EXTERN SwizError swizContextGetLastError

(

SwizContext *

context

)

Gets error status of context.

Parameters

context

SwizContext instance

Returns

Non-zero if it got errors

swizContextInit()

_SWIZ_EXTERN void swizContextInit

(

SwizContext *

context

)

Initialize attributes of a context.

Note

swizNewContext() calls this function internally.

Parameters

context

The context to initialize

swizContextSetArraySize()

_SWIZ_EXTERN SwizError swizContextSetArraySize	(	SwizContext *	context,
		int	array_size
	)

Sets the number of textures in a buffer.

Note

The default value is one.

Parameters

context	SwizContext instance
array_size	The number of textures in a buffer

Returns

Non-zero if it got errors

swizContextSetBlockInfo()

_SWIZ_EXTERN SwizError swizContextSetBlockInfo	(	SwizContext *	context,
		int	block_width,
		int	block_height,
		int	block_data_size
	)

Sets block size to context.

Note

"Block" means a block of compression, not a block of swizzling.
4x4 for all BC formats. 1x1 for all uncompressed formats.

Parameters

context	SwizContext instance
block_width	Width of a block
block_height	Height of a block
block_data_size	Data size of a block

Returns

Non-zero if it got errors

swizContextSetGobsHeight()

_SWIZ_EXTERN SwizError swizContextSetGobsHeight	(	SwizContext *	context,
		int	gobs_height
	)

Sets the max height of GOBs blocks for switch.

Note

The default value is 16. UE games use 8. Switch also supports 1, 2, 4, and 32.

Parameters

context	SwizContext instance
gobs_height	The max height for blocks of GOBs

Returns

Non-zero if it got errors

swizContextSetHasMips()

_SWIZ_EXTERN void swizContextSetHasMips	(	SwizContext *	context,
		int	has_mips
	)

Sets if textures have mipmaps or not.

Parameters

context	SwizContext instance
has_mips	Whether if texutures have mipmaps or not

swizContextSetPlatform()

_SWIZ_EXTERN SwizError swizContextSetPlatform	(	SwizContext *	context,
		SwizPlatform	platform
	)

Sets platform information to context.

Parameters

context	SwizContext instance
platform	This should be #SWIZ_PLATFORM_PS4

Returns

Non-zero if it got errors

swizContextSetTextureSize()

_SWIZ_EXTERN SwizError swizContextSetTextureSize	(	SwizContext *	context,
		int	width,
		int	height
	)

Sets width and height to context.

Parameters

context	SwizContext instance
width	Width of images
height	Height of images

Returns

Non-zero if it got errors

swizDoSwizzle()

_SWIZ_EXTERN SwizError swizDoSwizzle	(	const uint8_t *	data,
		uint8_t *	swizzled,
		SwizContext *	context
	)

Swizzles a texture.

Parameters

data	Unswizzled data. Data size should be equal to swizGetUnswizzledSize().
swizzled	Swizzled data. Data size should be equal to swizGetSwizzledSize().
context	SwizContext instance

Returns

Non-zero if it got errors

swizDoUnswizzle()

_SWIZ_EXTERN SwizError swizDoUnswizzle	(	const uint8_t *	data,
		uint8_t *	unswizzled,
		SwizContext *	context
	)

Unswizzles a texture.

Parameters

data	Swizzled data. Data size should be equal to swizGetSwizzledSize().
unswizzled	Unswizzled data. Data size should be equal to swizGetUnswizzledSize().
context	SwizContext instance

Returns

Non-zero if it got errors

swizFreeContext()

_SWIZ_EXTERN void swizFreeContext

(

SwizContext *

context

)

Frees the memory of a context.

Note

Every time a context is returned from swizNewContext(), this method should be called.

Parameters

context

The context to free memory

swizGetSwizzledSize()

_SWIZ_EXTERN uint32_t swizGetSwizzledSize

(

SwizContext *

context

)

Gets binary size of swizzled data.

Parameters

context

SwizContext instance

Returns

Binary size of swizzled data

swizGetUnswizzledSize()

_SWIZ_EXTERN uint32_t swizGetUnswizzledSize

(

SwizContext *

context

)

Gets binary size of unswizzled data.

Parameters

context

SwizContext instance

Returns

Binary size of unswizzled data

swizNewContext()

_SWIZ_EXTERN SwizContext * swizNewContext

(

)

Creates a new context.

---

The documentation for this struct was generated from the following file:

• include/console-swizzler.h