Class SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Image
  2. Image
    1. Gif
    2. Gif
      1. Block
        Extension
        AbstractExtension
        Application
        Comment
        GraphicControl
        PlainText

SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl Class representing a graphic control extension inside a GIF.

File: /SetaPDF v2/Core/Image/Gif/Block/Extension/GraphicControl.php

Class hierarchy

SetaPDF_Core_Image_Gif_Block_AbstractBlock
- SetaPDF_Core_Image_Gif_Block_Extension_AbstractExtension
  - SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl

Summary

Properties

$delayTime

public int SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$delayTime

The time that the frame shall be displayed.

$disposalMethodFlag

public int SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$disposalMethodFlag

The disposal method.

$reservedFlag

public int SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$reservedFlag

Flag reserved for future specification.

$transparentColorFlag

public bool SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$transparentColorFlag

A flag that determines if this block contains a transparent color.

$transparentColorIndex

public int SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$transparentColorIndex

An index for the color table that shall be transparent for the next rendering run.

$userInputFlag

public bool SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::$userInputFlag

A flag that tells the reader to wait for user input before rendering the next frame.

Static Methods

createExtension()

public static SetaPDF_Core_Image_Gif_Block_Extension_AbstractExtension::createExtension (

SetaPDF_Core_Reader_Binary $reader

): SetaPDF_Core_Image_Gif_Block_Extension_PlainText|SetaPDF_Core_Image_Gif_Block_Extension_Application|SetaPDF_Core_Image_Gif_Block_Extension_Comment|SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl

Creates an extension block instance.

Parameters

$reader : SetaPDF_Core_Reader_Binary

Exceptions

Throws SetaPDF_Core_Image_Exception

createExtensionOrImageDescriptor()

public static SetaPDF_Core_Image_Gif_Block_AbstractBlock::createExtensionOrImageDescriptor (

SetaPDF_Core_Reader_Binary $reader

): bool|SetaPDF_Core_Image_Gif_Block_Extension_Application|SetaPDF_Core_Image_Gif_Block_Extension_Comment|SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl|SetaPDF_Core_Image_Gif_Block_Extension_PlainText|SetaPDF_Core_Image_Gif_Block_ImageDescriptor

Creates a new block instance (extension or image descriptor).

Parameters

$reader : SetaPDF_Core_Reader_Binary

Exceptions

Throws SetaPDF_Core_Image_Exception

Methods

__construct()

public SetaPDF_Core_Image_Gif_Block_Extension_AbstractExtension::__construct (

SetaPDF_Core_Reader_Binary $reader

)

The constructor.

Parameters

$reader : SetaPDF_Core_Reader_Binary

Exceptions

Throws SetaPDF_Core_Image_Exception

_readBody()

protected SetaPDF_Core_Image_Gif_Block_Extension_GraphicControl::_readBody (

SetaPDF_Core_Image_Gif_Reader_Sequence $reader

): void

Reads the content of the extension.

Parameters

$reader : SetaPDF_Core_Image_Gif_Reader_Sequence

Exceptions

Throws SetaPDF_Core_Image_Exception