EmfPixelFormatDescriptor

Inheritance: java.lang.Object, com.aspose.imaging.fileformats.emf.MetaObject, com.aspose.imaging.fileformats.emf.emf.objects.EmfObject

public final class EmfPixelFormatDescriptor extends EmfObject

The PixelFormatDescriptor object can be used in EMR_HEADER records (section 2.3.4.2) to specify the pixel format of the output surface for the playback device context.

Constructors

ConstructorDescription
EmfPixelFormatDescriptor()

Methods

MethodDescription
getNSize()Gets or sets a 16-bit integer that specifies the size, in bytes, of this data structure.
setNSize(short value)Gets or sets a 16-bit integer that specifies the size, in bytes, of this data structure.
getNVersion()Gets or sets a 16-bit integer that MUST be set to 0x0001.
setNVersion(short value)Gets or sets a 16-bit integer that MUST be set to 0x0001.
getDwFlags()Gets or sets bit flags that specify properties of the pixel buffer that is used for output to the drawing surface.
setDwFlags(int value)Gets or sets bit flags that specify properties of the pixel buffer that is used for output to the drawing surface.
getIPixelType()Gets or sets the type of pixel data PFD_TYPE_RGBA 0x00 The pixel format is RGBA.
setIPixelType(byte value)Gets or sets the type of pixel data PFD_TYPE_RGBA 0x00 The pixel format is RGBA.
getCColorBits()Gets or sets the number of bits per pixel for RGBA pixel types, excluding the alpha bitplanes.
setCColorBits(byte value)Gets or sets the number of bits per pixel for RGBA pixel types, excluding the alpha bitplanes.
getCRedBits()Gets or sets Specifies the number of red bitplanes in each RGBA color buffer
setCRedBits(byte value)Gets or sets Specifies the number of red bitplanes in each RGBA color buffer
getCRedShift()Gets or sets Specifies the shift count in bits for red bitplanes in each RGBA color buffer.
setCRedShift(byte value)Gets or sets Specifies the shift count in bits for red bitplanes in each RGBA color buffer.
getCGreenBits()Gets or sets Specifies the number of green bitplanes in each RGBA color buffer
setCGreenBits(byte value)Gets or sets Specifies the number of green bitplanes in each RGBA color buffer
getCGreenShift()Gets or sets Specifies the shift count for green bitplanes in each RGBA color buffer.
setCGreenShift(byte value)Gets or sets Specifies the shift count for green bitplanes in each RGBA color buffer.
getCBlueBits()Gets or sets Specifies the number of blue bitplanes in each RGBA color buffer.
setCBlueBits(byte value)Gets or sets Specifies the number of blue bitplanes in each RGBA color buffer.
getCBlueShift()Gets or sets Specifies the shift count for blue bitplanes in each RGBA color buffer.
setCBlueShift(byte value)Gets or sets Specifies the shift count for blue bitplanes in each RGBA color buffer.
getCAlphaBits()Gets or sets Specifies the number of alpha bitplanes in each RGBA color buffer
setCAlphaBits(byte value)Gets or sets Specifies the number of alpha bitplanes in each RGBA color buffer
getCAlphaShift()Gets or sets Specifies the shift count for alpha bitplanes in each RGBA color buffer
setCAlphaShift(byte value)Gets or sets Specifies the shift count for alpha bitplanes in each RGBA color buffer
getCAccumBits()Gets or sets specifies the total number of bitplanes in the accumulation buffer.
setCAccumBits(byte value)Gets or sets specifies the total number of bitplanes in the accumulation buffer.
getCAccumRedBits()Gets or sets specifies the number of red bitplanes in the accumulation buffer
setCAccumRedBits(byte value)Gets or sets specifies the number of red bitplanes in the accumulation buffer
getCAccumGreenBits()Gets or sets specifies the number of green bitplanes in the accumulation
setCAccumGreenBits(byte value)Gets or sets specifies the number of green bitplanes in the accumulation
getCAccumBlueBits()Gets or sets specifies the number of blue bitplanes in the accumulation buffer.
setCAccumBlueBits(byte value)Gets or sets specifies the number of blue bitplanes in the accumulation buffer.
getCAccumAlphaBits()Gets or sets specifies the number of alpha bitplanes in the accumulation buffer
setCAccumAlphaBits(byte value)Gets or sets specifies the number of alpha bitplanes in the accumulation buffer
getCDepthBits()Gets or sets specifies the depth of the depth (z-axis) buffer.
setCDepthBits(byte value)Gets or sets specifies the depth of the depth (z-axis) buffer.
getCStencilBits()Gets or sets specifies the depth of the stencil buffer.
setCStencilBits(byte value)Gets or sets specifies the depth of the stencil buffer.
getCAuxBuffers()Gets or sets specifies the number of auxiliary buffers.
setCAuxBuffers(byte value)Gets or sets specifies the number of auxiliary buffers.
getILayerType()Gets or sets This field MAY be ignored
setILayerType(byte value)Gets or sets This field MAY be ignored
getBReserved()Gets or sets specifies the number of overlay and underlay planes.
setBReserved(byte value)Gets or sets specifies the number of overlay and underlay planes.
getDwLayerMask()Gets or sets This field MAY be ignored.
setDwLayerMask(int value)Gets or sets This field MAY be ignored.
getDwVisibleMask()Gets or sets specifies the transparent color or index of an underlay plane.
setDwVisibleMask(int value)Gets or sets specifies the transparent color or index of an underlay plane.
getDwDamageMask()Gets or sets This field MAY be ignored
setDwDamageMask(int value)Gets or sets This field MAY be ignored

EmfPixelFormatDescriptor()

public EmfPixelFormatDescriptor()

getNSize()

public short getNSize()

Gets or sets a 16-bit integer that specifies the size, in bytes, of this data structure.

Returns: short

setNSize(short value)

public void setNSize(short value)

Gets or sets a 16-bit integer that specifies the size, in bytes, of this data structure.

Parameters:

ParameterTypeDescription
valueshort

getNVersion()

public short getNVersion()

Gets or sets a 16-bit integer that MUST be set to 0x0001.

Returns: short

setNVersion(short value)

public void setNVersion(short value)

Gets or sets a 16-bit integer that MUST be set to 0x0001.

Parameters:

ParameterTypeDescription
valueshort

getDwFlags()

public int getDwFlags()

Gets or sets bit flags that specify properties of the pixel buffer that is used for output to the drawing surface. These properties are not all mutually exclusive; combinations of flags are allowed, except where noted otherwise.

Returns: int

setDwFlags(int value)

public void setDwFlags(int value)

Gets or sets bit flags that specify properties of the pixel buffer that is used for output to the drawing surface. These properties are not all mutually exclusive; combinations of flags are allowed, except where noted otherwise.

Parameters:

ParameterTypeDescription
valueint

getIPixelType()

public byte getIPixelType()

Gets or sets the type of pixel data PFD_TYPE_RGBA 0x00 The pixel format is RGBA. PFD_TYPE_COLORINDEX 0x01 Each pixel is an index in a color table.

Returns: byte

setIPixelType(byte value)

public void setIPixelType(byte value)

Gets or sets the type of pixel data PFD_TYPE_RGBA 0x00 The pixel format is RGBA. PFD_TYPE_COLORINDEX 0x01 Each pixel is an index in a color table.

Parameters:

ParameterTypeDescription
valuebyte

getCColorBits()

public byte getCColorBits()

Gets or sets the number of bits per pixel for RGBA pixel types, excluding the alpha bitplanes. For color table pixels, it is the size of each color table index

Returns: byte

setCColorBits(byte value)

public void setCColorBits(byte value)

Gets or sets the number of bits per pixel for RGBA pixel types, excluding the alpha bitplanes. For color table pixels, it is the size of each color table index

Parameters:

ParameterTypeDescription
valuebyte

getCRedBits()

public byte getCRedBits()

Gets or sets Specifies the number of red bitplanes in each RGBA color buffer

Returns: byte

setCRedBits(byte value)

public void setCRedBits(byte value)

Gets or sets Specifies the number of red bitplanes in each RGBA color buffer

Parameters:

ParameterTypeDescription
valuebyte

getCRedShift()

public byte getCRedShift()

Gets or sets Specifies the shift count in bits for red bitplanes in each RGBA color buffer.

Returns: byte

setCRedShift(byte value)

public void setCRedShift(byte value)

Gets or sets Specifies the shift count in bits for red bitplanes in each RGBA color buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCGreenBits()

public byte getCGreenBits()

Gets or sets Specifies the number of green bitplanes in each RGBA color buffer

Returns: byte

setCGreenBits(byte value)

public void setCGreenBits(byte value)

Gets or sets Specifies the number of green bitplanes in each RGBA color buffer

Parameters:

ParameterTypeDescription
valuebyte

getCGreenShift()

public byte getCGreenShift()

Gets or sets Specifies the shift count for green bitplanes in each RGBA color buffer.

Returns: byte

setCGreenShift(byte value)

public void setCGreenShift(byte value)

Gets or sets Specifies the shift count for green bitplanes in each RGBA color buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCBlueBits()

public byte getCBlueBits()

Gets or sets Specifies the number of blue bitplanes in each RGBA color buffer.

Returns: byte

setCBlueBits(byte value)

public void setCBlueBits(byte value)

Gets or sets Specifies the number of blue bitplanes in each RGBA color buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCBlueShift()

public byte getCBlueShift()

Gets or sets Specifies the shift count for blue bitplanes in each RGBA color buffer.

Returns: byte

setCBlueShift(byte value)

public void setCBlueShift(byte value)

Gets or sets Specifies the shift count for blue bitplanes in each RGBA color buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCAlphaBits()

public byte getCAlphaBits()

Gets or sets Specifies the number of alpha bitplanes in each RGBA color buffer

Returns: byte

setCAlphaBits(byte value)

public void setCAlphaBits(byte value)

Gets or sets Specifies the number of alpha bitplanes in each RGBA color buffer

Parameters:

ParameterTypeDescription
valuebyte

getCAlphaShift()

public byte getCAlphaShift()

Gets or sets Specifies the shift count for alpha bitplanes in each RGBA color buffer

Returns: byte

setCAlphaShift(byte value)

public void setCAlphaShift(byte value)

Gets or sets Specifies the shift count for alpha bitplanes in each RGBA color buffer

Parameters:

ParameterTypeDescription
valuebyte

getCAccumBits()

public byte getCAccumBits()

Gets or sets specifies the total number of bitplanes in the accumulation buffer.

Returns: byte

setCAccumBits(byte value)

public void setCAccumBits(byte value)

Gets or sets specifies the total number of bitplanes in the accumulation buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCAccumRedBits()

public byte getCAccumRedBits()

Gets or sets specifies the number of red bitplanes in the accumulation buffer

Returns: byte

setCAccumRedBits(byte value)

public void setCAccumRedBits(byte value)

Gets or sets specifies the number of red bitplanes in the accumulation buffer

Parameters:

ParameterTypeDescription
valuebyte

getCAccumGreenBits()

public byte getCAccumGreenBits()

Gets or sets specifies the number of green bitplanes in the accumulation

Returns: byte

setCAccumGreenBits(byte value)

public void setCAccumGreenBits(byte value)

Gets or sets specifies the number of green bitplanes in the accumulation

Parameters:

ParameterTypeDescription
valuebyte

getCAccumBlueBits()

public byte getCAccumBlueBits()

Gets or sets specifies the number of blue bitplanes in the accumulation buffer.

Returns: byte

setCAccumBlueBits(byte value)

public void setCAccumBlueBits(byte value)

Gets or sets specifies the number of blue bitplanes in the accumulation buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCAccumAlphaBits()

public byte getCAccumAlphaBits()

Gets or sets specifies the number of alpha bitplanes in the accumulation buffer

Returns: byte

setCAccumAlphaBits(byte value)

public void setCAccumAlphaBits(byte value)

Gets or sets specifies the number of alpha bitplanes in the accumulation buffer

Parameters:

ParameterTypeDescription
valuebyte

getCDepthBits()

public byte getCDepthBits()

Gets or sets specifies the depth of the depth (z-axis) buffer.

Returns: byte

setCDepthBits(byte value)

public void setCDepthBits(byte value)

Gets or sets specifies the depth of the depth (z-axis) buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCStencilBits()

public byte getCStencilBits()

Gets or sets specifies the depth of the stencil buffer.

Returns: byte

setCStencilBits(byte value)

public void setCStencilBits(byte value)

Gets or sets specifies the depth of the stencil buffer.

Parameters:

ParameterTypeDescription
valuebyte

getCAuxBuffers()

public byte getCAuxBuffers()

Gets or sets specifies the number of auxiliary buffers. Auxiliary buffers are not supported

Returns: byte

setCAuxBuffers(byte value)

public void setCAuxBuffers(byte value)

Gets or sets specifies the number of auxiliary buffers. Auxiliary buffers are not supported

Parameters:

ParameterTypeDescription
valuebyte

getILayerType()

public byte getILayerType()

Gets or sets This field MAY be ignored

Returns: byte

setILayerType(byte value)

public void setILayerType(byte value)

Gets or sets This field MAY be ignored

Parameters:

ParameterTypeDescription
valuebyte

getBReserved()

public byte getBReserved()

Gets or sets specifies the number of overlay and underlay planes. Bits 0 through 3 specify up to 15 overlay planes and bits 4 through 7 specify up to 15 underlay planes

Returns: byte

setBReserved(byte value)

public void setBReserved(byte value)

Gets or sets specifies the number of overlay and underlay planes. Bits 0 through 3 specify up to 15 overlay planes and bits 4 through 7 specify up to 15 underlay planes

Parameters:

ParameterTypeDescription
valuebyte

getDwLayerMask()

public int getDwLayerMask()

Gets or sets This field MAY be ignored.

Returns: int

setDwLayerMask(int value)

public void setDwLayerMask(int value)

Gets or sets This field MAY be ignored.

Parameters:

ParameterTypeDescription
valueint

getDwVisibleMask()

public int getDwVisibleMask()

Gets or sets specifies the transparent color or index of an underlay plane. When the pixel type is RGBA, dwVisibleMask is a transparent RGB color value. When the pixel type is color index, it is a transparent index value.

Returns: int

setDwVisibleMask(int value)

public void setDwVisibleMask(int value)

Gets or sets specifies the transparent color or index of an underlay plane. When the pixel type is RGBA, dwVisibleMask is a transparent RGB color value. When the pixel type is color index, it is a transparent index value.

Parameters:

ParameterTypeDescription
valueint

getDwDamageMask()

public int getDwDamageMask()

Gets or sets This field MAY be ignored

Returns: int

setDwDamageMask(int value)

public void setDwDamageMask(int value)

Gets or sets This field MAY be ignored

Parameters:

ParameterTypeDescription
valueint