GifGraphicsControlBlock Class

Summary: Gif graphics control block.

Module: aspose.imaging.fileformats.gif.blocks

Full Name: aspose.imaging.fileformats.gif.blocks.GifGraphicsControlBlock

Inheritance: IGifBlock, GifBlock

Aspose.Imaging Version: 24.7.0

Constructors

NameDescription
GifGraphicsControlBlock()Initializes a new instance of the GifGraphicsControlBlock class.
GifGraphicsControlBlock(delay_time, has_transparent_color, transparent_color_index, requires_user_input, disposal_method)Initializes a new instance of the GifGraphicsControlBlock class.
GifGraphicsControlBlock(flags, delay_time, transparent_color_index)Initializes a new instance of the GifGraphicsControlBlock class.

Properties

NameTypeAccessDescription
BLOCK_HEADER_SIZE [static]intrSpecifies the block header size.
EXTENSION_INTRODUCER [static]byterExtension introducer.
EXTENSION_LABEL [static]byterExtension label.
SUB_BLOCK_SIZE [static]byterGets the sub-block size.
delay_timeushortr/wGets or sets the frame delay time expressed in 1/100 seconds.
disposal_methodDisposalMethodr/wGets or sets the disposal method.
flagsbyter/wGets or sets the flags.
has_transparent_colorboolr/wGets or sets a value indicating whether graphics control block has transparent color.
is_changedboolr/wGets or sets a value indicating whether block has changed and requires save.
transparent_color_indexbyter/wGets or sets the transparent color index.
user_input_expectedboolr/wGets or sets a value indicating whether user input is expected.

Methods

NameDescription
create_flags(has_transparent_color, requires_user_input, disposal_method)Creates the flags.
save(stream)Saves the block to the specified stream.

Constructor: GifGraphicsControlBlock()

 GifGraphicsControlBlock() 

Initializes a new instance of the GifGraphicsControlBlock class.

Constructor: GifGraphicsControlBlock(delay_time, has_transparent_color, transparent_color_index, requires_user_input, disposal_method)

 GifGraphicsControlBlock(delay_time, has_transparent_color, transparent_color_index, requires_user_input, disposal_method) 

Initializes a new instance of the GifGraphicsControlBlock class.

Parameters:

ParameterTypeDescription
delay_timeushortThe delay time expressed in 1/100 seconds.
has_transparent_colorboolif set to true the transparentColorIndex is valid.
transparent_color_indexbyteThe transparent color index.
requires_user_inputboolif set to true the user input is expected.
disposal_methodDisposalMethodThe disposal method.

Constructor: GifGraphicsControlBlock(flags, delay_time, transparent_color_index)

 GifGraphicsControlBlock(flags, delay_time, transparent_color_index) 

Initializes a new instance of the GifGraphicsControlBlock class.

Parameters:

ParameterTypeDescription
flagsbyteThe flags.
delay_timeushortThe delay time expressed in 1/100 seconds.
transparent_color_indexbyteThe transparent color index.

Method: create_flags(has_transparent_color, requires_user_input, disposal_method) [static]

 create_flags(has_transparent_color, requires_user_input, disposal_method) 

Creates the flags.

Parameters:

ParameterTypeDescription
has_transparent_colorboolif set to true the GifGraphicsControlBlock has valid transparent color index.
requires_user_inputboolif set to true the user input is expected.
disposal_methodDisposalMethodThe disposal method.

Returns

TypeDescription
byteThe generated flags.

Method: save(stream)

 save(stream) 

Saves the block to the specified stream.

Parameters:

ParameterTypeDescription
stream_io.BufferedRandomThe stream to save data to.