SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
vtfpp::PSFrames Class Reference

Parses "frames" files as seen in The Orange Box PS3 port, in the TF/MOVIES.GRP file group. More...

#include <PSFrames.h>

Collaboration diagram for vtfpp::PSFrames:
Collaboration graph
[legend]

Public Member Functions

 PSFrames (std::vector< std::byte > &&psFramesData)
 PSFrames (std::span< const std::byte > psFramesData)
 PSFrames (const std::filesystem::path &psFramesPath)
uint32_t getFrameCount () const
uint32_t getFPS () const
uint16_t getWidth () const
uint16_t getHeight () const
std::vector< std::byte > getImageDataAs (ImageFormat newFormat, uint32_t frame) const
std::vector< std::byte > getImageDataAsBGR888 (uint32_t frame) const

Protected Member Functions

uint32_t getFrameOffset (uint32_t frame) const
uint32_t getFramePaletteAndImageSize () const

Protected Attributes

uint32_t frameCount = 0
uint32_t fps = 0
uint16_t width = 0
uint16_t height = 0
std::vector< std::byte > data

Detailed Description

Parses "frames" files as seen in The Orange Box PS3 port, in the TF/MOVIES.GRP file group.

Definition at line 12 of file PSFrames.h.

Constructor & Destructor Documentation

◆ PSFrames() [1/3]

PSFrames::PSFrames ( std::vector< std::byte > && psFramesData)
explicit

Definition at line 12 of file PSFrames.cpp.

◆ PSFrames() [2/3]

PSFrames::PSFrames ( std::span< const std::byte > psFramesData)
explicit

Definition at line 25 of file PSFrames.cpp.

◆ PSFrames() [3/3]

PSFrames::PSFrames ( const std::filesystem::path & psFramesPath)
explicit

Definition at line 28 of file PSFrames.cpp.

Member Function Documentation

◆ getFPS()

uint32_t PSFrames::getFPS ( ) const
nodiscard

Definition at line 35 of file PSFrames.cpp.

◆ getFrameCount()

uint32_t PSFrames::getFrameCount ( ) const
nodiscard

Definition at line 31 of file PSFrames.cpp.

◆ getFrameOffset()

uint32_t PSFrames::getFrameOffset ( uint32_t frame) const
nodiscardprotected

Definition at line 65 of file PSFrames.cpp.

◆ getFramePaletteAndImageSize()

uint32_t PSFrames::getFramePaletteAndImageSize ( ) const
nodiscardprotected

Definition at line 71 of file PSFrames.cpp.

◆ getHeight()

uint16_t PSFrames::getHeight ( ) const
nodiscard

Definition at line 43 of file PSFrames.cpp.

◆ getImageDataAs()

std::vector< std::byte > PSFrames::getImageDataAs ( ImageFormat newFormat,
uint32_t frame ) const
nodiscard

Definition at line 47 of file PSFrames.cpp.

◆ getImageDataAsBGR888()

std::vector< std::byte > PSFrames::getImageDataAsBGR888 ( uint32_t frame) const
nodiscard

Definition at line 51 of file PSFrames.cpp.

◆ getWidth()

uint16_t PSFrames::getWidth ( ) const
nodiscard

Definition at line 39 of file PSFrames.cpp.

Member Data Documentation

◆ data

std::vector<std::byte> vtfpp::PSFrames::data
protected

Definition at line 42 of file PSFrames.h.

◆ fps

uint32_t vtfpp::PSFrames::fps = 0
protected

Definition at line 38 of file PSFrames.h.

◆ frameCount

uint32_t vtfpp::PSFrames::frameCount = 0
protected

Definition at line 37 of file PSFrames.h.

◆ height

uint16_t vtfpp::PSFrames::height = 0
protected

Definition at line 40 of file PSFrames.h.

◆ width

uint16_t vtfpp::PSFrames::width = 0
protected

Definition at line 39 of file PSFrames.h.

The documentation for this class was generated from the following files: