PVRUtils Typedefs#

pvr::EglContext#

Typedef Documentation#

typedef std::unique_ptr<platform::EglContext_> pvr::EglContext#

A unique pointer to a pvr::platform::EglContext_ instance. Typdeffed to provide easier access and use of the EGLContext.

pvr::Rectanglei#

Typedef Documentation#

typedef Rectangle<int32_t> pvr::Rectanglei

The Rectanglei typedef is a specialised Rectangle for an int32_t.

pvr::platform::NativeDisplay#

Typedef Documentation#

typedef EGLNativeDisplayType pvr::platform::NativeDisplay#

EGL display type.

pvr::platform::NativePlatformHandles#

Typedef Documentation#

typedef std::shared_ptr<NativePlatformHandles_> pvr::platform::NativePlatformHandles#

Pointer to a struct of platform handles. Used to pass around the undefined NativePlatformHandles_ struct.

pvr::platform::NativeDisplayHandle#

Typedef Documentation#

typedef std::shared_ptr<NativeDisplayHandle_> pvr::platform::NativeDisplayHandle#

Pointer to a struct of platform handles. Used to pass around the undefined NativePlatformHandles_ struct.

pvr::platform::NativeWindow#

Typedef Documentation#

typedef EGLNativeWindowType pvr::platform::NativeWindow#

EGL window type.

pvr::ui::Sprite#

Typedef Documentation#

typedef std::shared_ptr<impl::Sprite_> pvr::ui::Sprite#

A Reference Counted Framework Object wrapping the Sprite_ interface. Represents anything you can use with the UIRenderer (Font, Text, Image, Group).

pvr::ui::TextElementWeakRef#

Typedef Documentation#

typedef std::weak_ptr<impl::TextElement_> pvr::ui::TextElementWeakRef#

A weak reference Counted Framework Object wrapping the TextElement_ class. The TextElement is a Sprite and contains a std::string of characters to be displayed with the Font that it uses.

pvr::ui::TextElement#

Typedef Documentation#

typedef std::shared_ptr<impl::TextElement_> pvr::ui::TextElement#

A Reference Counted Framework Object wrapping the TextElement_ class. The TextElement is a Sprite and contains a std::string of characters to be displayed with the Font that it uses.

pvr::ui::FontWeakRef#

Typedef Documentation#

typedef std::weak_ptr<impl::Font_> pvr::ui::FontWeakRef#

A weak reference Counted Framework Object wrapping the Font_ class. Is an Image object augmented by font metadata. Is used by the Text class.

pvr::ui::Text#

Typedef Documentation#

typedef std::shared_ptr<impl::Text_> pvr::ui::Text#

A Reference Counted Framework Object wrapping the Text_ interface.

pvr::ui::Image#

Typedef Documentation#

typedef std::shared_ptr<impl::Image_> pvr::ui::Image#

A Reference Counted Framework Object wrapping the Image_ class. The Image is a Sprite and contains a 2D texture that can be displayed.

pvr::ui::MatrixGroup#

Typedef Documentation#

typedef std::shared_ptr<impl::MatrixGroup_> pvr::ui::MatrixGroup#

A Reference Counted Framework Object wrapping the MatrixGroup_ class. Used to apply matrix transformations to several sprites all together and render them together.

A Reference Counted Framework Object wrapping the MatrixGroup_ class. Groups several sprites to apply some matrix transformation to them and render them all together.

pvr::ui::Font#

Typedef Documentation#

typedef std::shared_ptr<impl::Font_> pvr::ui::Font#

A Reference Counted Framework Object wrapping the Font_ class. Is an Image object augmented by font metadata. Is used by the Text class.

pvr::ui::PixelGroup#

Typedef Documentation#

typedef std::shared_ptr<impl::PixelGroup_> pvr::ui::PixelGroup#

A Reference Counted Framework Object wrapping the PixelGroup class. Groups several sprites to apply intuitive 2D operations and layouts to them.

A Reference Counted Framework Object wrapping the PixelGroup_ class. Groups several sprites to apply intuitive 2D operations and layouts to them.

pvr::ui::SpriteWeakRef#

Typedef Documentation#

typedef std::weak_ptr<impl::Sprite_> pvr::ui::SpriteWeakRef#

A weak reference Counted Framework Object wrapping the Sprite_ interface. Represents anything you can use with the UIRenderer (Font, Text, Image, Group).

pvr::ui::TextWeakRef#

Typedef Documentation#

typedef std::weak_ptr<impl::Text_> pvr::ui::TextWeakRef#

A weak reference Counted Framework Object wrapping the Text_ interface.

pvr::ui::Group#

Typedef Documentation#

typedef std::shared_ptr<impl::Group_> pvr::ui::Group#

A Reference Counted Framework Object wrapping the Group_ class. Groups several sprites to apply some transformation to them and render them all together.

pvr::ui::ImageWeakRef#

Typedef Documentation#

typedef std::weak_ptr<impl::Image_> pvr::ui::ImageWeakRef#

A weak Reference Counted Framework Object wrapping the Image_ class. The Image is a Sprite and contains a 2D texture that can be displayed.

pvr::utils::AsyncTexture#

Typedef Documentation#

typedef std::shared_ptr<async::IFrameworkAsyncResult<TexturePtr>> pvr::utils::AsyncTexture#

Provides a reference counted pointer to a IFrameworkAsyncResult specialised by a TexturePtr which will be used as the main interface for using API agnostic asynchronous textures.

pvr::utils::AsyncApiTexture#

Typedef Documentation#

typedef std::shared_ptr<async::IFrameworkAsyncResult<pvrvk::ImageView>> pvr::utils::AsyncApiTexture#

Provides a reference counted pointer to a IFrameworkAsyncResult specialised by an ImageView which will be used as the main interface for using API specific asynchronous textures.

pvr::utils::ImageUploadFuture#

Typedef Documentation#

typedef std::shared_ptr<ImageUploadFuture_> pvr::utils::ImageUploadFuture#

A ref-counted pointer to a Future of an Image Upload: A class that wraps the texture that “is being uploaded on a separate thread”, together with functions to “query if the upload is yet complete” and to “block until the upload is complete, if necessary, and return the result”.

pvr::utils::TexturePtr#

Typedef Documentation#

typedef std::shared_ptr<Texture> pvr::utils::TexturePtr#

Provides a reference counted pointer to a pvr::Texture which will be used for loading API agnostic texture data to disk.

pvr::utils::vma::PFN_AllocateDeviceMemoryFunction#

Typedef Documentation#

void(VKAPI_PTR * pvr::utils::vma::PFN_AllocateDeviceMemoryFunction )(Allocator allocator, uint32_t memoryType, pvrvk::DeviceMemory memory, VkDeviceSize size)

Callback function called after successful vkAllocateMemory.

pvr::utils::vma::Pool#

Typedef Documentation#

typedef std::shared_ptr<impl::Pool_> pvr::utils::vma::Pool#

Forwared-declared reference-counted handle to a Pool. For detailed documentation, see below.

pvr::utils::vma::DeviceMemoryWrapper#

Typedef Documentation#

typedef std::shared_ptr<impl::DeviceMemoryWrapper_> pvr::utils::vma::DeviceMemoryWrapper#

Forwared-declared reference-counted handle to a DeviceMemoryWrapper. For detailed documentation, see below.

pvr::utils::vma::Allocation#

Typedef Documentation#

typedef std::shared_ptr<impl::Allocation_> pvr::utils::vma::Allocation#

Forwared-declared reference-counted handle to a Allocation. For detailed documentation, see below.

pvr::utils::vma::PFN_FreeDeviceMemoryFunction#

Typedef Documentation#

void(VKAPI_PTR * pvr::utils::vma::PFN_FreeDeviceMemoryFunction )(Allocator allocator, uint32_t memoryType, pvrvk::DeviceMemory memory, VkDeviceSize size)

Callback function called before vkFreeMemory.

pvr::utils::vma::AllocatorWeakPtr#

Typedef Documentation#

typedef std::weak_ptr<impl::Allocator_> pvr::utils::vma::AllocatorWeakPtr#

Forwared-declared reference-counted handle to a Allocator. For detailed documentation, see below.

pvr::utils::vma::Allocator#

Typedef Documentation#

typedef std::shared_ptr<impl::Allocator_> pvr::utils::vma::Allocator#

Forwared-declared reference-counted handle to a Allocator. For detailed documentation, see below.