View source for Video Functions

{{:HuC Function Style}}
= Video Functions =

== disp_off ==
{|
|-
! [color=green]void[/color] disp_off([color=green]void[/color]);
|-
|
      Blank the display.
|}


== disp_on ==
{|
|-
! [color=green]void[/color] disp_on([color=green]void[/color]);
|-
|
      Enable display output.
|}


== cls ==
{|
|-
! [color=green]void[/color] cls([color=green]void[/color]);
|-
! [color=green]void[/color] cls([color=blue]int[/color] val);
|-
|
      Clear all the screen. Without parameters the screen
      is filled with a space character, else it's filled
      with the bat-value given as argument.
|}


== vsync ==
{|
|-
! [color=green]void[/color] vsync([color=green]void[/color]);
|-
! [color=green]void[/color] vsync([color=red]char[/color] nb_frame);
|-
|
      Synchronize your program to the video vertical blanking
      signal (VBL), which is 1/60th of a second.

      Without parameters this function return as soon as
      a VBL signal has been received, else your program will
      be synchronized to the number of frame you requested.
      So for example to run your game at 20fps, just use
      vsync(3) at the end of your game loop.
|}


== vreg ==
{|
|-
! [color=green]void[/color] vreg([color=red]char[/color] idx);
|-
! [color=green]void[/color] vreg([color=red]char[/color] idx, [color=blue]int[/color] val);
|-
|
      This function gives you direct access to the video
      processor (VDC) registers. The first form of this function
      is used to just select a VDC register (for custom accesses),
      and the second is used to set the value of a register
      (it also selects this register).
|}


== vram_addr ==
{|
|-
! [color=red]char[/color] vram_addr([color=red]char[/color] x, [color=red]char[/color] y);
|-
|
      Simple function to return the screen video memory address
      of the character located at position x/y.
|}


== set_screen_size ==
{|
|-
! [color=green]void[/color] set_screen_size([color=red]char[/color] size);
|-
|
      Change the virtual screen size. By default the startup
      code initialize a virtual screen of 64 characters wide
      and 32 character tall, but other values are possible,
      namely : 32x32, 128x32, 32x64, 64x64, or 128x64.

      More the virtual screen is big, less video memory
      you have for your graphics (font, tiles, sprites).
|}


== load_vram ==
{|
|-
! [color=green]void[/color] load_vram([color=blue]int[/color] vaddr, [color=blue]int[/color] *data, [color=blue]int[/color] nb);
|-
|
      Generic function to load data (BAT, CG, sprites)
      in video memory, at address 'vaddr'.

      'nb' is the number of 16-bit words to load.
|}


== load_bat ==
{|
|-
! [color=green]void[/color] load_bat([color=blue]int[/color] vaddr, [color=blue]int[/color] *bat_data, [color=red]char[/color] w, [color=red]char[/color] h);
|-
|
      Load a rectangular character attribute table (BAT)
      of width 'w' and of height 'h' in video memory,
      at address 'vaddr'.
|}


== load_background ==
{|
|-
! [color=green]void[/color] load_background([color=red]char[/color] *gfx, [color=blue]int[/color] *pal, [color=blue]int[/color] *bat, [color=red]char[/color] width, [color=red]char[/color] height);
|-
|
      This function is an all-in-one function, it is used
      to display a whole background image on the screen, like
      a game title image. It will load BG character data,

      it will load the palette, and finaly if will load the BAT.

      Use it with directives #incchr, #incpal and #incbat
      to manage the different type of data. The BG character
      data will be stored at address 0x1000 to 0x5000 in video
      memory.
|}


== set_xres ==
{|
|-
! [color=green]void[/color] set_xres([color=blue]int[/color] xres); [b][ 1.5+ ][/b]
|-
! [color=green]void[/color] set_xres([color=blue]int[/color] x_resolution, [color=blue]int[/color] color_correct_flag); [b][ 3.11+ ][/b]
|-
|
      Change the horizontal resolution to 'xres' (in pixels).
      This changes the video controller's registers to display
      more pixels on the screen; it does not affect virtual
      calculations.

      color_correct_flag indicates what kind of smoothing must be
      used, XRES_SHARP or XRES_SOFT.

      The 5MHz pixel clock will be used up to horizontal resolutions
      of 268.  7 MHz pixel clok will be used up to 356.  10MHz pixel clock
      will be used beyond this.  Maximum visible resolution seems to be
      about 512.
|}