VioSetState: Difference between revisions
m Ak120 moved page OS2 API:CPI:VioSetState to VioSetState |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Sets one or more of the following states: | Sets one or more of the following states: | ||
* Blink and background intensity switch | * Blink and background intensity switch | ||
* | * Colour registers | ||
* Overscan (border) | * Overscan (border) colour | ||
* Palette registers | * Palette registers | ||
* Target VioSetMode display configuration | * Target VioSetMode display configuration | ||
* Underline location | * Underline location | ||
==Syntax== | ==Syntax== | ||
VioSetState(RequestBlock, VioHandle) | |||
==Parameters== | ==Parameters== | ||
; RequestBlock (PVIOD) - input : Address of the video state structures (consisting of six different structures, depending on the request type): | ;RequestBlock (PVIOD) - input : Address of the video state structures (consisting of six different structures, depending on the request type): | ||
:{| | |||
!Type||Definition | |||
|- | |||
|0||Set palette registers | |||
|- | |||
|1||Set overscan (border) colour | |||
|- | |||
|2||Set blink/background intensity switch | |||
|- | |||
|3||Set colour registers | |||
|- | |||
|4||Reserved | |||
|- | |||
|5||Set underline location | |||
|- | |||
|6||Set target VioSetMode display configuration | |||
|} | |||
The six structures, depending on request type, are: | The six structures, depending on request type, are: | ||
* VIOPALSTATE | * VIOPALSTATE | ||
| Line 38: | Line 35: | ||
* VIOCOLORREG | * VIOCOLORREG | ||
* VIOSETULINELOC | * VIOSETULINELOC | ||
* VIOSETTARGET | * VIOSETTARGET | ||
;VioHandle (HVIO) - input : VIO presentation-space handle | |||
; VioHandle (HVIO) - input : VIO presentation-space handle | :Reserved. Must be 0. | ||
Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
;rc (APIRET) - returns:VioSetState returns one of the following values: | |||
VioSetState returns one of the following values: | :{| | ||
|0||NO_ERROR | |||
|- | |||
|355||ERROR_VIO_MODE | |||
|- | |||
|421||ERROR_VIO_INVALID_PARMS | |||
|- | |||
|436||ERROR_VIO_INVALID_HANDLE | |||
|- | |||
|438||ERROR_VIO_INVALID_LENGTH | |||
|} | |||
==Remarks== | ==Remarks== | ||
VioSetState allows setting of hardware-dependent features. Not all video hardware will | VioSetState allows setting of hardware-dependent features. Not all video hardware will honour these settings. | ||
[[Category: | [[Category:Vio]] | ||
Latest revision as of 22:10, 7 January 2024
Sets one or more of the following states:
- Blink and background intensity switch
- Colour registers
- Overscan (border) colour
- Palette registers
- Target VioSetMode display configuration
- Underline location
Syntax
VioSetState(RequestBlock, VioHandle)
Parameters
- RequestBlock (PVIOD) - input
- Address of the video state structures (consisting of six different structures, depending on the request type):
Type Definition 0 Set palette registers 1 Set overscan (border) colour 2 Set blink/background intensity switch 3 Set colour registers 4 Reserved 5 Set underline location 6 Set target VioSetMode display configuration
The six structures, depending on request type, are:
- VIOPALSTATE
- VIOOVERSCAN
- VIOINTENSITY
- VIOCOLORREG
- VIOSETULINELOC
- VIOSETTARGET
- VioHandle (HVIO) - input
- VIO presentation-space handle
- Reserved. Must be 0.
Return Code
- rc (APIRET) - returns
- VioSetState returns one of the following values:
0 NO_ERROR 355 ERROR_VIO_MODE 421 ERROR_VIO_INVALID_PARMS 436 ERROR_VIO_INVALID_HANDLE 438 ERROR_VIO_INVALID_LENGTH
Remarks
VioSetState allows setting of hardware-dependent features. Not all video hardware will honour these settings.